svn commit - mysqldoc@docsrva: r1435 - in trunk: . internals

[paul]

Author: paul
Date: 2006-02-23 21:28:01 +0100 (Thu, 23 Feb 2006)
New Revision: 1435

Log:
 r3548@kite-hub:  paul | 2006-02-23 14:27:27 -0600
 Add some notes to mysqltest doc.


Modified:
   trunk/
   trunk/internals/mysqltest.xml


Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:8058
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3538
   + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:8058
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3548

Modified: trunk/internals/mysqltest.xml
===================================================================
--- trunk/internals/mysqltest.xml	2006-02-23 17:46:17 UTC (rev 1434)
+++ trunk/internals/mysqltest.xml	2006-02-23 20:28:01 UTC (rev 1435)
@@ -72,7 +72,18 @@
         <filename>mysqltest.c</filename>.
       </para>
 
+<!-- THIS IS FOR MANPAGE IN REFMAN, NOT mysql manual itself
       <para>
+        This section describes the command options that
+        <command>mysqltest</command> implements.
+        <command>mysqltest</command> also implements a language for
+        writing test files. For details about this language and
+        instructions for writing test files, see the
+        <command>mysqltest</command> manual, available at [URL]
+      </para>
+-->
+
+      <para>
         <command>mysqltest</command> supports the following options:
       </para>
 
@@ -135,7 +146,7 @@
           </para>
 
           <para>
-            Define <literal>BIG_TEST</literal> to 1.
+            Define <literal>BIG_TEST</literal> as 1.
           </para>
         </listitem>
 
@@ -227,6 +238,11 @@
         </listitem>
 
         <listitem>
+          <remark role="todo">
+            This and the next several options should be commented out
+            for the manpage in the reference manual.
+          </remark>
+
           <para>
             <indexterm>
               <primary>mysqltest</primary>
@@ -322,7 +338,7 @@
           </para>
 
           <para>
-            Don't read default options from any option files.
+            Do not read default options from any option files.
           </para>
         </listitem>
 
@@ -564,7 +580,7 @@
           </para>
 
           <para>
-            Don't use memory allocation checking.
+            Do not use memory allocation checking.
           </para>
         </listitem>
 
@@ -584,8 +600,12 @@
             <option>-T <replaceable>num</replaceable></option>
           </para>
 
+          <remark role="todo">
+            All sleep commands, or just those with no argument?
+          </remark>
+
           <para>
-            The <literal>sleep</literal> command always sleeps
+            Cause the <literal>sleep</literal> command to always sleep
             <replaceable>num</replaceable> seconds.
           </para>
         </listitem>
@@ -757,6 +777,10 @@
       </para>
 
       <para>
+        Note: Cover the -- prefix. Cover comment writing.
+      </para>
+
+      <para>
         <command>mysqltest</command> supports the following commands:
       </para>
 
@@ -784,6 +808,10 @@
           <para>
             <literal>dec</literal>
           </para>
+
+          <para>
+            Decrement a variable. (Does it need to be numeric?)
+          </para>
         </listitem>
 
         <listitem>
@@ -976,6 +1004,10 @@
           <para>
             <literal>exec</literal>
           </para>
+
+          <para>
+            Difference from <literal>system</literal>?
+          </para>
         </listitem>
 
         <listitem>
@@ -1000,12 +1032,22 @@
           <para>
             <literal>inc</literal>
           </para>
+
+          <para>
+            Increment a variable.
+          </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>let</literal>
+            <literal>let $<replaceable>var_name</replaceable> =
+            <replaceable>value</replaceable>;</literal>
           </para>
+
+          <para>
+            Assign a value to a variable. (Multiple assignments per
+            statement possible?)
+          </para>
         </listitem>
 
         <listitem>
@@ -1046,14 +1088,52 @@
 
         <listitem>
           <para>
-            <literal>replace_column</literal>
+            <literal>replace_column <replaceable>col_num</replaceable>
+            <replaceable>value</replaceable>
+            [<replaceable>col_num</replaceable>
+            <replaceable>value</replaceable>] ...;</literal>
           </para>
+
+          <para>
+            Replace a column with a given value.
+          </para>
+
+          <para>
+            Do column numbers start with 0 or 1?
+          </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>replace_regex</literal>
+            <literal>replace_regex
+           
/<replaceable>pattern</replaceable>/<replaceable>replacement</replaceable>/[i]
+            ...</literal>
           </para>
+
+          <para>
+            Replace strings that match the pattern
+            <replaceable>pattern</replaceable> with
+            <replaceable>replacment</replaceable>. The
+            <literal>i</literal> modifier, if given, causes
+            case-insensitive pattern matching. Each instance of the
+            pattern on the line is replaced. Multiple
+            pattern/replacement pairs may be given.
+          </para>
+
+          <para>
+            The same patterns can be given as for the
+            <literal>REGEXP</literal> SQL operator. The pattern can
+            contain parentheses to mark substrings matched by the
+            pattern. Instances of
+            <literal>\<replaceable>N</replaceable></literal> in
the
+            replacement string cause insertion of the
+            <replaceable>N</replaceable>-th substring matched by the
+            pattern.
+          </para>
+
+          <para>
+            This command was added in MySQL 5.1.6.
+          </para>
         </listitem>
 
         <listitem>
@@ -1144,6 +1224,10 @@
           <para>
             <literal>system</literal>
           </para>
+
+          <para>
+            Difference from <literal>exec</literal>?
+          </para>
         </listitem>
 
         <listitem>
@@ -1162,6 +1246,17 @@
           <para>
             <literal>while</literal>
           </para>
+
+          <para>
+            Create a loop.
+          </para>
+
+<programlisting>
+while (<replaceable>condition</replaceable>)
+{
+  <replaceable>command list</replaceable>
+}
+</programlisting>
         </listitem>
 
       </itemizedlist>