List:Commits« Previous MessageNext Message »
From:paul Date:March 17 2006 8:54pm
Subject:svn commit - mysqldoc@docsrva: r1624 - in trunk: . mysqltest
View as plain text  
Author: paul
Date: 2006-03-17 21:54:49 +0100 (Fri, 17 Mar 2006)
New Revision: 1624

Log:
 r8760@frost:  paul | 2006-03-17 14:52:21 -0600
 Update several questions with answers based on jimw feedback.


Modified:
   trunk/
   trunk/mysqltest/command-reference.xml
   trunk/mysqltest/introduction.xml
   trunk/mysqltest/mysqltest.xml
   trunk/mysqltest/tutorial.xml


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

Modified: trunk/mysqltest/command-reference.xml
===================================================================
--- trunk/mysqltest/command-reference.xml	2006-03-17 20:49:34 UTC (rev 1623)
+++ trunk/mysqltest/command-reference.xml	2006-03-17 20:54:49 UTC (rev 1624)
@@ -393,14 +393,15 @@
         </para>
 
         <para>
-          [Q: To omit an argument, just leave it blank? What value is
-          used then? Same as whatever the default is for the
-          <literal>mysql_real_connect()</literal> C API function?]
+          Open a connection to the server and make the connection the
+          current connection.
         </para>
 
         <para>
-          Open a connection to the server. [Q: and make the connection
-          the current connection?]
+          To omit an argument, just leave it blank. For an omitted
+          argument, <command>mysqltest</command> uses an empty string
+          for the first five arguments, the default port or socket, or
+          no options.
         </para>
 
         <para>
@@ -444,12 +445,10 @@
             <para>
               <replaceable>db_name</replaceable> is the default database
               to use. As a special case, <literal>*NO-ONE*</literal>
-              means that no default database should be selected.
+              means that no default database should be selected. You can
+              also leave <replaceable>db_name</replaceable> blank to
+              select no database.
             </para>
-
-            <para>
-              [Q: you can't just leave it blank to select no database?]
-            </para>
           </listitem>
 
           <listitem>
@@ -481,8 +480,9 @@
         </itemizedlist>
 
         <para>
-          [Q: If a connection attempt fails initially, there is some
-          kind of retry behavior?]
+          If a connection attempt fails initially,
+          <command>mysqltest</command> retries five times if the
+          abort-on-error setting is enabled.
         </para>
 
         <para>
@@ -537,20 +537,10 @@
           (&lsquo;<literal>;</literal>&rsquo;).
         </para>
 
-        <para>
-          [Q: The Wiki docs state a max length of 16, but that doesn't
-          work:
-        </para>
-
-<programlisting>
--- delimiter 1234567890123456
-mysqltest: At line 2: End of line junk detected: "6"
-</programlisting>
-
-        <para>
-          Perhaps this is a bug? Or else MAX_DELIMITER includes the
-          terminating null byte?]
-        </para>
+        <remark>
+          The Wiki docs state a max length of 16, but that isn't
+          correct. The value of 16 includes the terminating null byte.
+        </remark>
       </listitem>
 
       <listitem>
@@ -580,8 +570,8 @@
           Disable or enable abort-on-error behavior. This setting is
           enabled by default. With this setting enabled,
           <command>mysqltest</command> aborts the test when a statement
-          sent to the server results in an unexpected error [Q: and does
-          not generate the <filename>.reject</filename> file?]
+          sent to the server results in an unexpected error, and does
+          not generate the <filename>.reject</filename> file.
         </para>
 
         <para>
@@ -707,14 +697,9 @@
 
         <para>
           Disable or enable automatic reconnect for dropped connections.
-          [Q: Is the default whatever the default is for the client
-          library (which varies for different versions)?]
+          (The default depends the client library version.) This command
+          applies to connections made afterward.
         </para>
-
-        <para>
-          [Q: When does this command apply? To connections made
-          afterward?]
-        </para>
       </listitem>
 
       <listitem>
@@ -740,13 +725,9 @@
 
         <para>
           Disable or enable parsing of statements to determine whether
-          they go to the master or slave.
+          they go to the master or slave. (MySQL 4.0 and up only.) The
+          default is whatever the default is for the C API library.
         </para>
-
-        <para>
-          [Q: The default is whatever the default is for the C API
-          library?] [MySQL 4.0 and up only]
-        </para>
       </listitem>
 
       <listitem>
@@ -856,6 +837,14 @@
 </programlisting>
 
         <para>
+          You use <literal>error</literal> to specify shell status
+          values for testing the value of shell commands executed via
+          the <literal>exec</literal> command. This does apply to the
+          <literal>system</literal>, for which the command status is
+          ignored.
+        </para>
+
+        <para>
           [Q: There is not a strict 1&minus;1 relationship between error
           numbers and SQLSTATE values (some SQLSTATE values are used for
           more than one error number). Is there some implication for
@@ -877,15 +866,6 @@
           [Q: 0 and S00000 are equivalent for specifying <quote>no
           error</quote>?]
         </para>
-
-        <para>
-          [Q: It appears that you use <literal>error</literal> to
-          specify shell status values for testing the value of shell
-          commands executed via the <literal>exec</literal> command.
-          However, this does not seem to aply to the
-          <literal>system</literal>, for which the command status seems
-          to be ignored?]
-        </para>
       </listitem>
 
       <listitem>
@@ -902,10 +882,10 @@
         </para>
 
         <para>
-          [Q: What is the advantage of using <literal>eval
+          The advantage of using <literal>eval
           <replaceable>statement</replaceable></literal> versus just
-          <replaceable>statement</replaceable>? Variable reference
-          expansion?]
+          <replaceable>statement</replaceable> is that
+          <literal>eval</literal> provides variable expansion.
         </para>
       </listitem>
 
@@ -953,14 +933,11 @@
         </para>
 
         <para>
-          Terminate the test case.
+          Terminate the test case. This is considered a <quote>normal
+          termination,</quote> such that using <literal>exit</literal>
+          does not result in evaluation of the test case as having
+          failed.
         </para>
-
-        <para>
-          [Q: Is this considered a <quote>normal termination,</quote>
-          such that using <literal>exit</literal> does not result in
-          evaluation of the test case as having failed?]
-        </para>
       </listitem>
 
       <listitem>
@@ -1038,14 +1015,10 @@
         <para>
           Ping the server. This executes the
           <literal>mysql_ping()</literal> C API function. The function
-          result is discarded.
+          result is discarded. The effect is that if the connection has
+          dropped and reconnect is enabled, pinging the server causes a
+          reconnect.
         </para>
-
-        <para>
-          [Q: I suppose the effect is that if the connection has dropped
-          and reconnect is enabled, pinging the server causes a
-          reconnect?]
-        </para>
       </listitem>
 
       <listitem>
@@ -1367,19 +1340,19 @@
         </para>
 
         <para>
+          This command is unavailable for
+          <command>mysqltest_embedded</command>, the version of
+          <command>mysqltest</command> built with support for
+          <literal>libmysqld</literal>.
+        </para>
+
+        <para>
           [Q: Does "manager" mean the Instance Manager? If so, is the
           connection to the manager made using the parameters specified
           by the
           <option>--manager-<replaceable>xxx</replaceable></option>
           command-line options?]
         </para>
-
-        <para>
-          [Q: This command is unavailable for
-          <command>mysqltest_embedded</command>, the version of
-          <command>mysqltest</command> built with support for
-          <literal>libmysqld</literal>?]
-        </para>
       </listitem>
 
       <listitem>
@@ -1394,10 +1367,10 @@
         </para>
 
         <para>
-          [Q: This command is unavailable for
+          This command is unavailable for
           <command>mysqltest_embedded</command>, the version of
           <command>mysqltest</command> built with support for
-          <literal>libmysqld</literal>?]
+          <literal>libmysqld</literal>.
         </para>
       </listitem>
 
@@ -1447,7 +1420,7 @@
         </para>
 
         <para>
-          [Q: Max nesting level?]
+          The maximum nesting level is 16.
         </para>
       </listitem>
 

Modified: trunk/mysqltest/introduction.xml
===================================================================
--- trunk/mysqltest/introduction.xml	2006-03-17 20:49:34 UTC (rev 1623)
+++ trunk/mysqltest/introduction.xml	2006-03-17 20:54:49 UTC (rev 1624)
@@ -103,17 +103,17 @@
 
     <listitem>
       <para>
-        The test case can fail by producing incorrect trace/protocol
-        output. As a test runs, it writes the result from
-        <literal>SELECT</literal>, <literal>SHOW</literal>, and other
-        statements to a file. This file is compared to the expected
-        trace found in the <filename>mysql-test/r</filename> directory
-        (in a file with a <filename>.result</filename> suffix). If the
-        files containing the expected and actual results differ, the
-        test case fails and the difference is presented for evaluation.
-        When test case failure occurs, the actual test result is written
-        to a file in the <filename>mysql-test/r</filename> directory
-        with a <filename>.reject</filename> suffix.
+        The test case can fail by producing incorrect output. As a test
+        runs, it writes the result from <literal>SELECT</literal>,
+        <literal>SHOW</literal>, and other statements to a file. This
+        file is compared to the expected trace found in the
+        <filename>mysql-test/r</filename> directory (in a file with a
+        <filename>.result</filename> suffix). If the files containing
+        the expected and actual results differ, the test case fails and
+        the difference is presented for evaluation. When test case
+        failure occurs, the actual test result is written to a file in
+        the <filename>mysql-test/r</filename> directory with a
+        <filename>.reject</filename> suffix.
       </para>
     </listitem>
 

Modified: trunk/mysqltest/mysqltest.xml
===================================================================
--- trunk/mysqltest/mysqltest.xml	2006-03-17 20:49:34 UTC (rev 1623)
+++ trunk/mysqltest/mysqltest.xml	2006-03-17 20:54:49 UTC (rev 1624)
@@ -193,14 +193,14 @@
               <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.
+              the options given in the file if the options are different
+              from those required for the previous test case.
             </para>
 
             <para>
-              [Q: Is the -master.opt file used for the "main" server in
-              a test, even if no replication is involved?]
+              Note that the <filename>-master.opt</filename> file is
+              used for the <quote>main</quote> server of a test, even if
+              no replication is involved.
             </para>
           </listitem>
 
@@ -216,21 +216,22 @@
             <para>
               A filename of the form
               <filename><replaceable>test_name</replaceable>-im.opt</filename>
-              ...
+              provides Instance Manager options.
             </para>
+          </listitem>
 
+          <listitem>
             <para>
-              [Q: is for what ...?]
+              The <filename>disabled.def</filename> file contains
+              information about deferred/disabled tests.
             </para>
+
+            <para>
+              [TODO: Describe the format of this file]
+            </para>
           </listitem>
 
         </itemizedlist>
-
-        <para>
-          [Q: Are there other <quote>magic</quote> filenames?
-          <literal>disabled.def</literal> contains info about
-          deferred/disabled tests?]
-        </para>
       </listitem>
 
       <listitem>
@@ -305,16 +306,18 @@
 
       <listitem>
         <para>
-          The <filename>std_data</filename> directory contains [Q:
-          What?]
+          The <filename>std_data</filename> directory contains data
+          files used by some of the tests.
         </para>
       </listitem>
 
       <listitem>
         <para>
           The <filename>var</filename> directory is used during test
-          runs for log and temporary files. [Q: and anything else?] This
-          directory cannot be shared by simultaneous test runs.
+          runs for various kinds of files: log files, temporary files,
+          trace files, Unix socket files for the servers started during
+          the tests, and so forth. This directory cannot be shared by
+          simultaneous test runs.
         </para>
       </listitem>
 
@@ -372,25 +375,18 @@
       <literal>enable_query_log</literal> commands control logging of
       input SQL statements. The <literal>disable_result_log</literal>
       and <literal>enable_result_log</literal> commands control logging
-      of SQL statement results.
+      of SQL statement results, and warning or error messages resulting
+      from those statements. Output from the <literal>echo</literal>
+      command is not disabled.
     </para>
 
     <para>
-      [Q: I believe the _result_log commands affect not just normal
-      statement output, but also warning or error messages resulting
-      from those statements?] [Q: I'm not sure how the _result_log
-      commands affect logging of <command>mysqltest</command> command
-      output. <literal>echo</literal> command output seems to appear
-      regardless, <literal>eval</literal> command output seems to be
-      turned off/on?]
+      [Q: I'm not sure how the _result_log commands affect logging of
+      <command>mysqltest</command> command output.
+      <literal>eval</literal> command output seems to be turned off/on?]
     </para>
 
     <para>
-      Result files are sometimes called <quote>protocol files.</quote>
-      [Q: Why? What is the meaning of that designation?]
-    </para>
-
-    <para>
       <command>mysqltest</command> reads a test case file from its
       standard input by default. The <option>--test-file</option> or
       <option>-x</option> option can be given to name a test case file
@@ -429,7 +425,10 @@
           With <option>--result-file</option> but not
           <option>--record</option>, <command>mysqltest</command> reads
           the expected results from the given file and compares them
-          with the actual results.
+          with the actual results. If the results do not match,
+          <command>mysqltest</command> writes a
+          <filename>.reject</filename> file in the same directory as the
+          result file and exits with an error.
         </para>
       </listitem>
 
@@ -445,12 +444,6 @@
     </itemizedlist>
 
     <para>
-      [Q: Which program writes the <filename>.reject</filename> files?
-      <command>mysql-test-run</command> or
-      <command>mysqltest</command>?]
-    </para>
-
-    <para>
       <command>mysqltest</command> itself knows nothing of the
       <filename>t</filename> and <filename>r</filename> directories
       under the <filename>mysql-test</filename> directory. The use of
@@ -1156,7 +1149,11 @@
                     <option>--record</option>,
                     <command>mysqltest</command> reads the expected
                     results from the given file and compares them with
-                    the actual results.
+                    the actual results. If the results do not match,
+                    <command>mysqltest</command> writes a
+                    <filename>.reject</filename> file in the same
+                    directory as the result file and exits with an
+                    error.
                   </para>
 
                   <para>
@@ -1197,12 +1194,9 @@
               <para>
                 Pass the argument as an argument to the embedded server.
                 For example, <option>--server-arg=--tmpdir=/tmp</option>
-                or <option>--server-arg=--core</option>.
+                or <option>--server-arg=--core</option>. Up to 64
+                arguments can be given.
               </para>
-
-              <para>
-                [Q: Max 64 args allowed?]
-              </para>
             </listitem>
 
             <listitem>
@@ -1223,13 +1217,8 @@
 
               <para>
                 Read arguments for the embedded server from the given
-                file.
+                file. The file should contain one argument per line.
               </para>
-
-              <para>
-                [Q: What's the format of this file? One option per
-                line?]
-              </para>
             </listitem>
 
             <listitem>
@@ -1298,13 +1287,8 @@
                 [BUG: <option>--sleep=0</option> has no effect. That is,
                 it doesn't cause a sleep of 0 seconds. Instead,
                 <literal>sleep</literal> commands in the test file sleep
-                by the amount specified in the file. Probably we could
-                fix this by setting <literal>opt_sleep</literal> to -1
-                (not 0), and using GET_UINT (not GET_INT) in the option
-                structure to prevent negative option values rom being
-                given on the command line. That way, we could test for
-                -1 as the "no setting given" value, and we'd be able to
-                tell that 0 actually means "sleep 0 seconds."]
+                by the amount specified in the file. I have filed a bug
+                report with a suggested patch. (Bug#18312)]
               </para>
             </listitem>
 
@@ -1347,8 +1331,11 @@
               </para>
 
               <para>
-                Use stored procedures for select. [Q: Which means what,
-                exactly?] This option was added in MySQL 5.0.19.
+                Execute DML statements within a stored procedure. For
+                every DML statement, <command>mysqltest</command>
+                creates and invokes a stored procedure that executes the
+                statement rather than executing the statement directly.
+                This option was added in MySQL 5.0.19.
               </para>
             </listitem>
 
@@ -1502,8 +1489,8 @@
               </para>
 
               <para>
-                Use views for select. [Q: Which means what, exactly?]
-                This option was added in MySQL 5.0.19.
+                Every <literal>SELECT</literal> statement is wrapped
+                inside a view. This option was added in MySQL 5.0.19.
               </para>
             </listitem>
 
@@ -1568,6 +1555,8 @@
             latter in this document, but
             <command>mysql-test-run.pl</command> should still be
             considered experimental.
+            <command>mysql-test-run.pl</command> will be the only script
+            available as of MySQL 5.2.
           </para>
 
           <para>
@@ -1589,9 +1578,9 @@
             For each <replaceable>test_name</replaceable> argument,
             <command>mysql-test-run</command> runs the named test case.
             With no <replaceable>test_name</replaceable> arguments,
-            <command>mysql-test-run</command> [Q: does what? Runs all
+            <command>mysql-test-run</command> runs all
             <filename>.test</filename> files in the
-            <filename>t</filename> subdirectory?]
+            <filename>t</filename> subdirectory.
           </para>
 
           <para>
@@ -1605,16 +1594,11 @@
           </para>
 
           <para>
-            <command>mysql-test-run</command> appears to define some
-            environment variables:
+            <command>mysql-test-run</command> defines several
+            environment variables. Some of them are listed in the
+            following table.
           </para>
 
-          <para>
-            <literal>MYSQL_TEST</literal> (path to
-            <command>mysqltest</command> binary?),
-            <literal>MYSQLTEST_VARDIR</literal>, [Q: what else?]
-          </para>
-
           <informaltable>
             <tgroup cols="2">
               <colspec colwidth="30*"/>
@@ -1629,14 +1613,9 @@
                   <entry>Pathname to <command>mysqltest</command> binary</entry>
                 </row>
                 <row>
-                  <entry><literal>MYSQL_TEST_WINDIR</literal></entry>
-                  <entry>Pathname to the <filename>mysql-test</filename> directory on Windows [Q:
-                    Is that correct]</entry>
-                </row>
-                <row>
                   <entry><literal>MYSQLTEST_VARDIR</literal></entry>
-                  <entry>Pathname to the <filename>var</filename> directory [Q: for logs,
-                    temporary files, etc. ???]</entry>
+                  <entry>Pathname to the <filename>var</filename> directory that is used for
+                    logs, temporary files, and so forth</entry>
                 </row>
                 <row>
                   <entry><literal>MASTER_MYPORT</literal></entry>
@@ -1897,11 +1876,10 @@
               </para>
 
               <para>
-                [Q: What happens if a test has an
-                <filename>.opt</filename> file that requires the server
-                to be restarted with specific options? Does
-                <option>--extern</option> preclude being able to run
-                such tests?]
+                Note: If a test has an <filename>.opt</filename> file
+                that requires the server to be restarted with specific
+                options, the file will not be used. The test likely will
+                fail as a result.
               </para>
             </listitem>
 
@@ -2007,14 +1985,10 @@
               </para>
 
               <para>
-                Do not use an already running server. This is the
-                default.
-              </para>
-
-              <para>
-                [Q: So what does this mean?
+                Do not use an already running server.
                 <command>mysql-run-test</command> starts a server and
-                tells <command>mysqltest</command> to use it?]
+                tells <command>mysqltest</command> to use it. This is
+                the default as of MySQL 4.1.
               </para>
             </listitem>
 
@@ -2399,19 +2373,6 @@
 
             <listitem>
               <para>
-                <option>--skip-*</option>
-              </para>
-
-              <para>
-                [Q: This is a bit of an odd one.
-                <option>--skip-*</option> is what's given in the code,
-                following all the other <option>--skip</option> options.
-                What's it supposed to stand for?
-              </para>
-            </listitem>
-
-            <listitem>
-              <para>
                 <indexterm>
                   <primary>mysql-test-run</primary>
                   <secondary>skip-master-binlog option</secondary>
@@ -2526,13 +2487,29 @@
                   <secondary>mysql-test-run</secondary>
                 </indexterm>
 
-                <option>--skip-test=<replaceable>[Q: WHAT GOES
-                HERE?]</replaceable></option>
+                <option>--skip-test=<replaceable>regex</replaceable></option>
               </para>
+
+              <para>
+                Specify a regular expression that matches the names of
+                tests to skip.
+              </para>
             </listitem>
 
             <listitem>
               <para>
+                <option>--skip-*</option>
+              </para>
+
+              <para>
+                <option>--skip-*</option> options not otherwise
+                recognized by <command>mysql-test-run</command> are
+                passed to the master server.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
                 <indexterm>
                   <primary>mysql-test-run</primary>
                   <secondary>slave-binary option</secondary>
@@ -2644,9 +2621,14 @@
                   <secondary>mysql-test-run</secondary>
                 </indexterm>
 
-                <option>--start-from=<replaceable>[Q: WHAT GOES
-                HERE?]</replaceable></option>
+                <option>--start-from=<replaceable>test_name</replaceable></option>
               </para>
+
+              <para>
+                <command>mysql-test-run</command> sorts the list of
+                names indicating which tests to run, and then begins
+                with <replaceable>test_name</replaceable>.
+              </para>
             </listitem>
 
             <listitem>
@@ -2869,9 +2851,12 @@
                   <secondary>mysql-test-run</secondary>
                 </indexterm>
 
-                <option>--user-test=<replaceable>[Q: WHAT GOES
-                HERE]</replaceable></option>
+                <option>--user-test=<replaceable>val</replaceable></option>
               </para>
+
+              <para>
+                Unused, apparently.
+              </para>
             </listitem>
 
             <listitem>
@@ -3783,18 +3768,6 @@
       </para>
 
       <para>
-        [Q: What does the following paragraph mean? Does it refer to the
-        fact that <command>mysql-test-run</command> defines some
-        environment variables such as <literal>MYSQL_TEST</literal>
-        before it invokes <command>mysqltest</command>?]
-      </para>
-
-      <para>
-        FIXME some environment variables are passed from the environment
-        to test language variables, list them. Why not all??
-      </para>
-
-      <para>
         The <command>mysqltest</command> program is a small interpreter
         for a special test language. Lines that it doesn't recognize as
         its own commands are assumed to be SQL statements to be sent to
@@ -3803,10 +3776,6 @@
       </para>
 
       <para>
-        Lines starting with a "#" in the test files are comments.
-      </para>
-
-      <para>
         Commands to the test engine itself are often put into comments,
         like --cmd. This sometimes leads to conflicts with comments that
         start with the same word as a command.

Modified: trunk/mysqltest/tutorial.xml
===================================================================
--- trunk/mysqltest/tutorial.xml	2006-03-17 20:49:34 UTC (rev 1623)
+++ trunk/mysqltest/tutorial.xml	2006-03-17 20:54:49 UTC (rev 1624)
@@ -64,8 +64,11 @@
 </programlisting>
 
     <para>
-      [Q: What is the point of showing <option>--local</option> in the
-      example? Isn't that the default anyway?]
+      The <option>--local</option> option tells
+      <command>mysql-test-run</command> not to use an already running
+      server, but to start a server itself to use for the tests. This
+      option is the default as of MySQL 4.1, so it is necessary only
+      before 4.1.
     </para>
 
     <para>
@@ -139,15 +142,11 @@
       Instead, the <command>mysql-test-run</command> program will start
       the server or servers needed on ports that do not conflict with
       ports used a production server, if you happen to have one on the
-      same machine.
+      same machine. (The test run uses ports in the range around 9300,
+      so production servers should not use ports in that range.) [Q:
+      Doesn't the preceding paragraph assume that if you have a
     </para>
 
-    <para>
-      [Q: Doesn't the preceding paragraph assume that if you have a
-      production server, it doesn't happen to be using any non-standard
-      ports used by servers started by the test programs?]
-    </para>
-
     <section id="tutorial-simultaneous-test-runs">
 
       <title>Constraints on Simultaneous Test Runs</title>
@@ -168,14 +167,11 @@
         <filename>mysql-test</filename> directory on a shared drive, at
         the same time. The <filename>mysql-test/var</filename> directory
         created and used by <command>mysql-test-run</command> cannot be
-        shared between simultaneous test runs.
+        shared between simultaneous test runs. A test run can use the
+        <option>--var=<replaceable>dir_path</replaceable></option>
+        option to specify an alternate directory not used by other runs.
       </para>
 
-      <para>
-        [Q: Is there a <command>mysql-test-run</command> option that can
-        be used to cause each test run to use a separate var directory?]
-      </para>
-
     </section>
 
   </section>
@@ -612,16 +608,11 @@
 </programlisting>
 
       <para>
-        [Q: Is the <quote>protocol</quote> file the result file or the
-        reject file? I have seen the term applied to both.]
+        Running the test as shown creates a result file named
+        <filename>mysql-test/r/foo.result</filename>. The file has this
+        content:
       </para>
 
-      <para>
-        Running the test as shown creates a file named
-        <filename>mysql-test/r/foo.result</filename>, also called the
-        <quote>protocol file.</quote> The file has this content:
-      </para>
-
 <programlisting>
 drop table if exists t1,t2;
 create table t1 (
@@ -652,13 +643,14 @@
       <para>
         At this point, you should inspect the result file and determine
         whether its contents are as expected. If so, let it be part of
-        your test case.
+        your test case. If the result is not as expected, you have found
+        a problem, either with the server or the test. Determine the
+        cause of the problem and fix it. For example, the test might
+        produce output that varies from run to run. To deal with this,
+        you can postprocess the output before the comparison occurs. See
+        <xref linkend="tutorial-output-postprocessing"/>.
       </para>
 
-      <para>
-        [Q: And if it's not as expected, what do you do?]
-      </para>
-
     </section>
 
     <section id="tutorial-expecting-errors">
@@ -762,7 +754,7 @@
         error-reporting context. Wouldn't it be better for
         <command>mysqltest</command> to consistently display the same
         kind of information? Or would this require many test results to
-        be updated?]
+        be updated?] [TODO: File bug report]
       </para>
 
     </section>
@@ -771,19 +763,20 @@
 
       <title>Controlling the Information Produced by a Test Case</title>
 
-      <para>
-        [Q: Isn't the first sentence inaccurate? For example, the result
-        also contains output from <literal>echo</literal> commands, and
-        <literal>exec</literal> (but apparently not from
-        <literal>system</literal>)?]
-      </para>
+      <remark>
+        The result apparently includes no output from
+        <literal>system</literal>.
+      </remark>
 
       <para>
-        By default, the test engine produces output only from
-        <literal>select</literal>, <literal>show</literal>, and other
-        SQL statements that you expect to produce output (that is,
-        statements that create a result set). But it can be instructed
-        to be more or less verbose, including other data as well.
+        By default, the <command>mysqltest</command> test engine
+        produces output only from <literal>select</literal>,
+        <literal>show</literal>, and other SQL statements that you
+        expect to produce output (that is, statements that create a
+        result set). It also produces output from certain commands such
+        as <literal>echo</literal> and <literal>exec</literal>.
+        <command>mysqltest</command> can be instructed to be more or
+        less verbose, including other data as well.
       </para>
 
       <para>
@@ -1037,21 +1030,15 @@
 
       <para>
         But sometimes you need to restart the server to use some options
-        in the form of extra command-line options.
-        <command>mysql-test-run</command> will restart the server just
-        before running a test case, if there exists a file
-        <filename>mysql-test/t/<replaceable>test_name</replaceable>-master.opt</filename>
-        with the options that you want to use. After the test case is
-        completed, the server will be restarted again, with the default
-        arguments.
+        in the form of extra command-line options. You can specify these
+        options in a file named
+        <filename>mysql-test/t/<replaceable>test_name</replaceable>-master.opt</filename>.
+        <command>mysql-test-run</command> checks these
+        <filename>.opt</filename> files and restarts the server if a
+        test case requires different options than the previous test
+        case.
       </para>
 
-      <para>
-        [Q: Is that correct, or does <command>mysql-test-run</command>
-        restart the server only when it notices that a test case
-        requires different options than the previous test case?]
-      </para>
-
     </section>
 
   </section>

Thread
svn commit - mysqldoc@docsrva: r1624 - in trunk: . mysqltestpaul17 Mar