From a74d1b0b6cda4b928d993be0d0ab65686827136f Mon Sep 17 00:00:00 2001
From: ocelot-inc <pgulutzan@ocelot.ca>
Date: Thu, 12 Dec 2013 17:42:26 -0700
Subject: [PATCH] Changes due to 1.5.2 announcement
---
doc/user/language-reference.xml | 19 +++++++++--
doc/user/server-administration.xml | 20 ++---------
doc/user/stored-procedures.xml | 54 ++++++++++++++----------------
doc/user/tutorial.xml | 6 ++++
4 files changed, 50 insertions(+), 49 deletions(-)
diff --git a/doc/user/language-reference.xml b/doc/user/language-reference.xml
index f38d3bc2f4..23014525f9 100644
--- a/doc/user/language-reference.xml
+++ b/doc/user/language-reference.xml
@@ -270,13 +270,14 @@ fail: can't save snapshot, errno 17 (File exists)
</term>
<listitem><para>
<programlisting>
-localhost> show info
+<prompt>localhost></prompt> <userinput>show info</userinput>
---
info:
- version: "1.4.5-128-ga91962c"
+ version: "1.5.2-8-g54a279d"
uptime: 441524
pid: 12315
logger_pid: 12316
+ snapshot_pid: 0
lsn: 15481913304
recovery_lag: 0.000
recovery_last_update: 1306964594.980
@@ -306,6 +307,15 @@ info:
</listitem>
</varlistentry>
+ <varlistentry>
+ <term xml:id="show-index" xreflabel="SHOW INDEX">
+ <emphasis role="tntadmin">show index</emphasis>
+ </term>
+ <listitem><para>
+ Show the number of keys and the amount of memory used by each each index.
+ </para></listitem>
+ </varlistentry>
+
<varlistentry>
<term xml:id="show-stat" xreflabel="SHOW STAT">
<emphasis role="tntadmin">show stat</emphasis>
@@ -348,6 +358,11 @@ statistics:
the % of <olink targetptr="slab_alloc_arena"/> that is
already distributed to the slab allocator.
</para>
+ <para>
+ <emphasis role="strong">bytes_waste</emphasis> contains
+ the amount of memory wasted by the slab allocator due to
+ internal fragmentation.
+ </para>
<para>
</para>
</listitem>
diff --git a/doc/user/server-administration.xml b/doc/user/server-administration.xml
index 23df218d78..d69a91f478 100644
--- a/doc/user/server-administration.xml
+++ b/doc/user/server-administration.xml
@@ -60,6 +60,7 @@ Option is one of the following (in alphabetical order by the long form of the op
long form: <code>--a[dmin-port] [=] <replaceable>port-number</replaceable></code>.
Effect: Client will look for the server on the port designated by port-number.
Notes: This is the <quote>administrative</quote> port. The default value is 33015.
+ If --port is specified then there is no need to specify --admin-port, the client will discover it.
</para></listitem>
</varlistentry>
<varlistentry>
@@ -162,6 +163,7 @@ Option is one of the following (in alphabetical order by the long form of the op
Effect: Client will look for the server on the port designated by port-number.
Example: <code>--port = 33013</code>
Notes: This is the <quote>primary port</quote> also known as the <quote>read/write data</quote> port. The default value is 33013.
+ If --admin-port is specified then there is no need to specify --port, the client will discover it.
</para></listitem>
</varlistentry>
<varlistentry>
@@ -314,15 +316,6 @@ a newline (line feed).
Notes: The client sends to the server's administrative port.
</para></listitem>
</varlistentry>
- <varlistentry>
- <term xml:id="utility-tarantool-notee" xreflabel="utility-tarantool-notee">NOTEE</term>
- <listitem><para>
- Syntax: <code>NOTEE</code>.
- Effect: The client ceases to write to a file, thus canceling the effect of the TEE statement.
- Example: <code>NOTEE</code>.
- Notes: The client sends nothing to the server.
- </para></listitem>
- </varlistentry>
<varlistentry>
<term xml:id="utility-tarantool-ping" xreflabel="utility-tarantool-ping">PING</term>
<listitem><para>
@@ -416,15 +409,6 @@ a newline (line feed).
SHOW INJECTIONS is only available in debug mode.
</para></listitem>
</varlistentry>
- <varlistentry>
- <term xml:id="utility-tarantool-tee" xreflabel="utility-tarantool-tee">TEE</term>
- <listitem><para>
- Syntax: <code>TEE <replaceable>string-literal</replaceable></code>.
- Effect: The client begins logging in the file identified by string-literal.
- Example: <code>TEE '/home/tarantool_user/log.txt'</code>.
- Notes: TEE may also be set up via an option on the command line. The client sends nothing to the server.
- </para></listitem>
- </varlistentry>
<varlistentry>
<term xml:id="utility-tarantool-update" xreflabel="utility-tarantool-update">UPDATE</term>
<listitem><para>
diff --git a/doc/user/stored-procedures.xml b/doc/user/stored-procedures.xml
index 269f7fc966..6eddd65884 100644
--- a/doc/user/stored-procedures.xml
+++ b/doc/user/stored-procedures.xml
@@ -477,44 +477,40 @@ localhost> <userinput>lua box.select(5, 1, 'firstname', 'lastname')</userinput>
<varlistentry>
<term>
- <emphasis role="lua" xml:id="box.update">box.update(space_no, key, format, ...)</emphasis>
+ <emphasis role="lua" xml:id="box.update">box.update(space_no, key, format, {field_no, value}...)</emphasis>
</term>
<listitem>
<para>
- Update a tuple identified by a primary
- <code>key</code>. If a key is multipart,
- it is passed in as a Lua table. Update arguments follow,
- described by <code>format</code>.
- The format and arguments are passed to
+ Update a tuple.
+ The <code>space_no</code> and <code>key</code> arguments
+ identify the tuple; if a key is multipart then it is
+ passed as a Lua table.
+ The <code>format</code> argument is a sequence of
+ pairs of characters, where the first character in each pair
+ is the operation specifier, and the second character in
+ each pair is the operation argument.
+ The <code>{field_no, value}</code> arguments are the
+ field numbers of affected fields and applicable values.
+ For some operations the field number can be -1, meaning
+ the last field in the tuple.
+ There must be a pair of {field_no, value} arguments
+ for each character pair in the format argument.
+ The format and {field_no, value} arguments are passed to
<code>box.pack()</code> and the result is sent
to <code>box.process()</code>.
- A correct <code>format</code> is a sequence of
- pairs: update operation, operation arguments. A
- single character of format describes either an
- operation which needs to take place or operation
- argument. A format specifier also works as a
- placeholder for the number of a field, which needs
- to be updated, or for an argument value.
- For example:
- <simplelist>
- <member><code>+p=p</code> — add a value
- to one field and assign another,
- </member>
- <member><code>:p</code> — splice a
- field: start at offset, cut length bytes, and add a
- string.</member>
- <member><code>#p</code> — delete a
- field.</member>
- <member><code>!p</code> — insert a field
- (before the one specified).</member>
- </simplelist>
- Possible format specifiers are: <quote>+</quote>
+ Possible operation specifiers are: <quote>+</quote>
for addition, <quote>-</quote> for subtraction,
<quote>&</quote> for bitwise AND,
<quote>|</quote> for bitwise OR, <quote>^</quote>
for bitwise exclusive OR (XOR), <quote>:</quote>
- for string splice and <quote>p</quote> for
- operation argument.
+ for string splice, <quote>!</quote> for insertion.
+ Possible operation arguments are: <quote>p</quote>.
+ Thus in the instruction <code>lua box.update(0,44,'+p=p',1,55,3,'x')</code>
+ the space number is 0, the primary-key value is 44,
+ the format is '+p=p' meaning "add a value to a field
+ and then assign a value to a field", the first affected field
+ is field 1 and the value which will be added to it is 55, the second affected field
+ is field 3 and the value which will be assigned to it is 'x'.
<bridgehead renderas="sect4">Returns</bridgehead>
Returns the updated tuple.
<bridgehead renderas="sect4">Example</bridgehead>
diff --git a/doc/user/tutorial.xml b/doc/user/tutorial.xml
index 6e4f36a1d1..c83d876504 100644
--- a/doc/user/tutorial.xml
+++ b/doc/user/tutorial.xml
@@ -399,6 +399,12 @@ These example scripts assume that the intent is to download from the master bran
the server and the client (but not the documentation), and run tests after build.
</para>
+<para>
+To build with SUSE 13.1, the steps are as described above, except that the appropriate YaST2 package names are:
+binutils-devel, libuuid-devel, cmake, ncurses-devel, lynx, jing, libxml2-devel, docbook_5, saxon, libxslt-devel.
+The python connector can be installed with <code>sudo easy_install pip</code> and <code>sudo pip install tarantool</code>.
+</para>
+
</section>
<section xml:id="getting-started-start-stop">
<title>Starting Tarantool and making your first database</title>
--
GitLab