List:Commits« Previous MessageNext Message »
From:paul Date:March 1 2006 8:10pm
Subject:svn commit - mysqldoc@docsrva: r1477 - in trunk: . mysqltest
View as plain text  
Author: paul
Date: 2006-03-01 21:10:33 +0100 (Wed, 01 Mar 2006)
New Revision: 1477

Log:
 r8281@frost:  paul | 2006-03-01 14:10:22 -0600
 mysqltest material.


Modified:
   trunk/
   trunk/mysqltest/mysqltest.xml


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

Modified: trunk/mysqltest/mysqltest.xml
===================================================================
--- trunk/mysqltest/mysqltest.xml	2006-03-01 18:44:09 UTC (rev 1476)
+++ trunk/mysqltest/mysqltest.xml	2006-03-01 20:10:33 UTC (rev 1477)
@@ -9,6 +9,8 @@
 <!ENTITY title-mysqltest-for-manual "Program to Run Test Cases">
 <!ENTITY title-mysql-test-run-for-manpage "<command>mysqltest</command> driver program">
 <!ENTITY title-mysql-test-run-for-manual "<command>mysqltest</command> Driver Program">
+<!ENTITY title-mysql-stress-test-for-manpage "server stress test program">
+<!ENTITY title-mysql-stress-test-for-manual "Server Stress Test Program">
 ]>
 <book lang="en">
 
@@ -1279,6 +1281,100 @@
 
     </section>
 
+    <section id="fake-id-for-mysql-stress-test-manpage-section-wrapper">
+
+      <title>fake title for mysql-stress-test.pl manpage section wrapper</title>
+
+      <refentry id="mysql-stress-test">
+
+        <indexterm>
+          <primary><command>mysql-stress-test.pl</command></primary>
+        </indexterm>
+
+        <refmeta>
+          <refentrytitle>mysql-stress-test.pl</refentrytitle>
+           
+          <manvolnum>1</manvolnum>
+          <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+          <refmiscinfo class="source">MySQL</refmiscinfo>
+          <refmiscinfo class="version">&current-series;</refmiscinfo>
+          <refmiscinfo class="refman">&title-mysql-stress-test-for-manual;</refmiscinfo>
+        </refmeta>
+
+        <refnamediv>
+          <refname>mysql-stress-test.pl</refname>
+           
+          <refpurpose>&title-mysql-stress-test-for-manpage;</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+          <cmdsynopsis>
+            <command>mysql-stress-test.pl [<replaceable>options</replaceable>]</command>
+          </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsection id="mysql-stress-test-description">
+
+          <title>Description</title>
+
+          <para>
+            [Fill in]
+          </para>
+
+          <para>
+            Invoke <command>mysql-stress-test.pl</command> like this:
+          </para>
+
+<programlisting>
+shell&gt; <userinput>mysql-stress-test.pl [<replaceable>options</replaceable>]</userinput>
+</programlisting>
+
+        </refsection>
+
+        <refsection id="mysql-stress-test-options">
+
+          <title><command>mysql-stress-test.pl</command> Options</title>
+
+          <para>
+            <command>mysql-stress-test.pl</command> supports the
+            following options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql-stress-test.pl</primary>
+                  <secondary>help option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>help option</primary>
+                  <secondary>mysql-stress-test.pl</secondary>
+                </indexterm>
+
+                <option>--help</option>
+              </para>
+
+              <para>
+                Display a help message and exit.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            [Fill in this section with all
+            <command>mysql-stress-test.pl</command> options]
+          </para>
+
+        </refsection>
+
+      </refentry>
+
+    </section>
+
   </chapter>
 
   <chapter id="mysqltest-language">
@@ -1418,6 +1514,28 @@
     </para>
 
     <para>
+      [So when do you end a command with a semicolon and when not? Is it
+      that if you begin a command with
+      &lsquo;<literal>--</literal>&rsquo;, you don't use a semicolon,
+      otherwise you do? Is that the way you get a multiple-line
+      <literal>let</literal> value (by not beginning
+      <literal>--</literal> and ending with <literal>;</literal>)? Thus,
+      these are equivalent?
+    </para>
+
+<programlisting>
+--sleep 2
+sleep 2;
+</programlisting>
+
+    <para>
+      So, is it like this? A <literal>--</literal> command is terminated
+      by a newline, regardless of how many delimiters it contains. A
+      command without <literal>--</literal> is terminated by semicolon,
+      no matter how many newlines it contains.
+    </para>
+
+    <para>
       [Ambiguity] Although it is <emphasis>possible</emphasis> to write
       a comment that begins with &lsquo;<literal>--</literal>&rsquo;, it
       is better to use &lsquo;<literal>#</literal>&rsquo; instead. For
@@ -2059,14 +2177,6 @@
         </para>
 
         <para>
-          [Variable names appear not to be case sensitive. This leads to
-          an ambiguity: If you refer to a variable named
-          <literal>$path</literal>, is that a
-          <command>mysqltest</command> variable, or the
-          <literal>$PATH</literal> environment variable?]
-        </para>
-
-        <para>
           [The Wiki says there can be no space between the var name and
           the <literal>=</literal> sign. Really true?]
         </para>
@@ -2545,6 +2655,10 @@
     </para>
 
     <para>
+      Variables:
+    </para>
+
+    <para>
       <literal>$mysql_errno</literal> is a built-in variable that
       contains the numeric error returned by the most recent command
       sent to the server, or 0 if the command executes successfully.
@@ -2553,6 +2667,19 @@
     </para>
 
     <para>
+      You can refer to environment variables. [How is a variable
+      determined to be such? If it's not recognized as a built-in
+      variable or a variable defined in the script?]
+    </para>
+
+    <para>
+      [Variable names appear not to be case sensitive. This leads to an
+      ambiguity: If you refer to a variable named
+      <literal>$path</literal>, is that a <command>mysqltest</command>
+      variable, or the <literal>$PATH</literal> environment variable?]
+    </para>
+
+    <para>
       If an expected error is specified and that error occurs,
       <command>mysqltest</command> continues reading input. If the
       command is successful or a different error occurs,
@@ -2587,13 +2714,42 @@
 
       <listitem>
         <para>
-          The <filename>t</filename> directory contains test case files.
+          The <filename>t</filename> directory contains test case input
+          files.
         </para>
 
         <para>
+          A filename ending with <filename>.test</filename> is a test
+          case file. A filename of the form
+          <filename><replaceable>test_name</replaceable>-master.opt</filename>
+          provides options to associate with the named test case.
+          <literal>mysql-test-run</literal> [?] restarts the server with
+          the options given in the file before running the test case.
+          Then it restarts the server with default options before
+          running the next test case.
+        </para>
+
+        <para>
+          [What other <quote>magic</quote> filenames are there?]
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
           The <filename>r</filename> directory contains test case result
           files.
         </para>
+
+        <para>
+          A filename of the form
+          <filename><replaceable>test_name</replaceable>.result</filename>
+          is the expected result for the named test case. This file
+          corresponds to the test case file
+          <filename>t/<replaceable>test_name</replaceable>.test</filename>..
+          A filename of the form
+          <filename><replaceable>test_name</replaceable>.reject</filename>
+          contains output for the named test case if the test fails.
+        </para>
       </listitem>
 
       <listitem>
@@ -2669,6 +2825,15 @@
       <literal>enable_result_log</literal> commands.
     </para>
 
+    <para>
+      Result files are sometimes called <quote>protocol files.</quote>
+    </para>
+
+    <para>
+      Result output columns are separated by tab characters. [Is there
+      any way to change the separator?]
+    </para>
+
   </chapter>
 
 </book>

Thread
svn commit - mysqldoc@docsrva: r1477 - in trunk: . mysqltestpaul1 Mar