Author: paul
Date: 2006-06-13 16:40:20 +0200 (Tue, 13 Jun 2006)
New Revision: 2363
Log:
r11231@frost: paul | 2006-06-13 09:37:13 -0500
Fill in descriptions for some mysql-test-run{,.pl} options.
Modified:
trunk/
trunk/mysqltest/programs.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:10468
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:11181
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:7663
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:10468
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:11231
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:7663
Modified: trunk/mysqltest/programs.xml
===================================================================
--- trunk/mysqltest/programs.xml 2006-06-13 14:14:23 UTC (rev 2362)
+++ trunk/mysqltest/programs.xml 2006-06-13 14:40:20 UTC (rev 2363)
@@ -1207,7 +1207,10 @@
<command>mysql-test-run.pl</command> supports the options in
the following list. An argument of <option>--</option> tells
<command>mysql-test-run.pl</command> not to process any
- following arguments as options.
+ following arguments as options. (A description of differences
+ between the options supported by
+ <command>mysql-test-run.pl</command> and
+ <command>mysql-test-run</command> appears following the list.)
</para>
<itemizedlist>
@@ -1260,9 +1263,11 @@
</itemizedlist>
<para>
- [Fill in this section with all
- <command>mysql-test-run.pl</command> options that
- <command>mysql-test-run</command> does not have]
+ [TODO: after copying the option list from mysql-test-run,
+ delete those that are shell-version-only, and find/process any
+ notes about sh/pl differences. Update "mysql-test-run" to
+ "mysql-test-run.pl" in index entries and descriptions.
+ Integrate the following list of Perl-version-only options.]
</para>
<para>
@@ -1284,8 +1289,13 @@
<secondary>mysql-test-run.pl</secondary>
</indexterm>
- <option>--benchdir</option>
+ <option>--benchdir=<replaceable>path</replaceable></option>
</para>
+
+ <para>
+ The directory where the benchmark suite is located. The
+ default path is <filename>../../mysql-bench</filename>.
+ </para>
</listitem>
<listitem>
@@ -1302,6 +1312,10 @@
<option>--check-testcases</option>
</para>
+
+ <para>
+ Check test cases for side effects.
+ </para>
</listitem>
<listitem>
@@ -1318,6 +1332,11 @@
<option>--client-ddd</option>
</para>
+
+ <para>
+ Start <command>mysqltest</command> in the
+ <command>ddd</command> debugger.
+ </para>
</listitem>
<listitem>
@@ -1334,6 +1353,10 @@
<option>--client-debugger</option>
</para>
+
+ <para>
+ Start <command>mysqltest</command> in the named debugger.
+ </para>
</listitem>
<listitem>
@@ -1350,6 +1373,12 @@
<option>--cursor-protocol</option>
</para>
+
+ <para>
+ Pass the <option>--cursor-protocol</option> option to
+ <command>mysqltest</command> (implies
+ <option>--ps-protocol</option>).
+ </para>
</listitem>
<listitem>
@@ -1366,6 +1395,10 @@
<option>--debugger</option>
</para>
+
+ <para>
+ Start <command>mysqld</command> the named debugger.
+ </para>
</listitem>
<listitem>
@@ -1382,6 +1415,11 @@
<option>--im-mysqld1-port</option>
</para>
+
+ <para>
+ TCP/IP port number to use for first
+ <command>mysqld</command>, controlled by Instance Manager.
+ </para>
</listitem>
<listitem>
@@ -1398,6 +1436,11 @@
<option>--im-mysqld2-port</option>
</para>
+
+ <para>
+ TCP/IP port number to use for second
+ <command>mysqld</command>, controlled by Instance Manager.
+ </para>
</listitem>
<listitem>
@@ -1414,6 +1457,11 @@
<option>--im-port</option>
</para>
+
+ <para>
+ TCP/IP port number to use for <command>mysqld</command>,
+ controlled by Instance Manager.
+ </para>
</listitem>
<listitem>
@@ -1430,6 +1478,11 @@
<option>--manual-debug</option>
</para>
+
+ <para>
+ Use a server that has already been started by the user in
+ a debugger.
+ </para>
</listitem>
<listitem>
@@ -1446,6 +1499,11 @@
<option>--netware</option>
</para>
+
+ <para>
+ Run <command>mysqld</command> with options needed on
+ NetWare.
+ </para>
</listitem>
<listitem>
@@ -1462,6 +1520,11 @@
<option>--reorder</option>
</para>
+
+ <para>
+ Reorder tests to minimize the number of server restarts
+ needed.
+ </para>
</listitem>
<listitem>
@@ -1478,6 +1541,11 @@
<option>--script-debug</option>
</para>
+
+ <para>
+ Enable debug output for
+ <command>mysql-test-run.pl</command> itself.
+ </para>
</listitem>
<listitem>
@@ -1494,6 +1562,11 @@
<option>--skip-im</option>
</para>
+
+ <para>
+ Do not start Instance Manager and skip Instance Manager
+ test cases.
+ </para>
</listitem>
<listitem>
@@ -1510,6 +1583,11 @@
<option>--skip-ssl</option>
</para>
+
+ <para>
+ Do not start <command>mysqld</command> with support for
+ SSL connections.
+ </para>
</listitem>
<listitem>
@@ -1526,6 +1604,11 @@
<option>--sp-protocol</option>
</para>
+
+ <para>
+ Pass the <option>--sp-protocol</option> option to
+ <command>mysqltest</command>.
+ </para>
</listitem>
<listitem>
@@ -1542,6 +1625,12 @@
<option>--start-dirty</option>
</para>
+
+ <para>
+ Start servers (without initialization) for the specified
+ test case or cases, if any, and then exit. You can then
+ manually run the test cases.
+ </para>
</listitem>
<listitem>
@@ -1556,8 +1645,13 @@
<secondary>mysql-test-run.pl</secondary>
</indexterm>
- <option>--suite</option>
+ <option>--suite=<replaceable>suite_name</replaceable></option>
</para>
+
+ <para>
+ Run the named test suite. The default name is
+ <literal>main</literal>.
+ </para>
</listitem>
<listitem>
@@ -1572,8 +1666,12 @@
<secondary>mysql-test-run.pl</secondary>
</indexterm>
- <option>--suite-timeout</option>
+ <option>--suite-timeout=<replaceable>minutes</replaceable></option>
</para>
+
+ <para>
+ Specify the maximum test suite runtime.
+ </para>
</listitem>
<listitem>
@@ -1590,6 +1688,10 @@
<option>--testcase-timeout</option>
</para>
+
+ <para>
+ Specify the maximum test case runtime.
+ </para>
</listitem>
<listitem>
@@ -1606,6 +1708,11 @@
<option>--unified-diff</option>, <option>--udiff</option>
</para>
+
+ <para>
+ Use unified diff format when presenting differences
+ between expected and actual test case results.
+ </para>
</listitem>
<listitem>
@@ -1620,8 +1727,13 @@
<secondary>mysql-test-run.pl</secondary>
</indexterm>
- <option>--valgrind-path</option>
+ <option>--valgrind-path=<replaceable>path</replaceable></option>
</para>
+
+ <para>
+ Specify the pathname to the <command>valgrind</command>
+ executable.
+ </para>
</listitem>
<listitem>
@@ -1636,8 +1748,14 @@
<secondary>mysql-test-run.pl</secondary>
</indexterm>
- <option>--vardir</option>
+ <option>--vardir=<replaceable>path</replaceable></option>
</para>
+
+ <para>
+ Specify the path where files generated during the test run
+ are stored. The default location is
+ <filename>./var</filename>.
+ </para>
</listitem>
<listitem>
@@ -1654,10 +1772,50 @@
<option>--view-protocol</option>
</para>
+
+ <para>
+ Pass the <option>--view-protocol</option> option to
+ <command>mysqltest</command>.
+ </para>
</listitem>
</itemizedlist>
+ <para>
+ <command>mysql-test-run</command> supports the following
+ options not supported by <command>mysql-test-run.pl</command>:
+ <option>--ndb-verbose</option>,
+ <option>--ndb_mgm-extra-opts</option>,
+ <option>--ndb_mgmd-extra-opts</option>,
+ <option>--ndbd-extra-opts</option>, <option>--purify</option>,
+ <option>--use-old-data</option>,
+ <option>--valgrind-mysqltest-all</option>.
+ </para>
+
+ <para>
+ Conversely, <command>mysql-test-run.pl</command> supports the
+ following options not supported by
+ <command>mysql-test-run</command>:
+ <option>--benchdir</option>,
+ <option>--check-testcases</option>,
+ <option>--client-ddd</option>,
+ <option>--client-debugger</option>,
+ <option>--cursor-protocol</option>,
+ <option>--debugger</option>,
+ <option>--im-mysqld1-port</option>,
+ <option>--im-mysqld2-port</option>,
+ <option>--im-port</option>, <option>--manual-debug</option>,
+ <option>--netware</option>, <option>--reorder</option>,
+ <option>--script-debug</option>, <option>--skip-im</option>,
+ <option>--skip-ssl</option>, <option>--sp-protocol</option>,
+ <option>--start-dirty</option>, <option>--suite</option>,
+ <option>--suite-timeout</option>,
+ <option>--testcase-timeout</option>, <option>--udiff</option>,
+ <option>--unified-diff</option>,,
+ <option>--valgrind-path</option>, <option>--vardir</option>,
+ <option>--view-protocol</option>.
+ </para>
+
</refsection>
</refentry>
@@ -1808,7 +1966,10 @@
<command>mysql-test-run</command> supports the options in the
following list. An argument of <option>--</option> tells
<command>mysql-test-run</command> not to process any following
- arguments as options.
+ arguments as options. (A description of differences between
+ the options supported by <command>mysql-test-run</command> and
+ <command>mysql-test-run.pl</command> appears in
+ <xref linkend="mysql-test-run-pl-options"/>.)
</para>
<itemizedlist>
@@ -1827,6 +1988,10 @@
<option>--bench</option>
</para>
+
+ <para>
+ Run the benchmark suite.
+ </para>
</listitem>
<listitem>
@@ -1864,6 +2029,11 @@
<option>--client-gdb</option>
</para>
+
+ <para>
+ Start <command>mysqltest</command> in the
+ <command>gdb</command> debugger.
+ </para>
</listitem>
<listitem>
@@ -1880,6 +2050,10 @@
<option>--comment=<replaceable>str</replaceable></option>
</para>
+
+ <para>
+ Write <replaceable>str</replaceable> to the output.
+ </para>
</listitem>
<listitem>
@@ -1896,6 +2070,11 @@
<option>--compress</option>
</para>
+
+ <para>
+ Compress all information sent between the client and the
+ server if both support compression.
+ </para>
</listitem>
<listitem>
@@ -1912,6 +2091,11 @@
<option>--ddd</option>
</para>
+
+ <para>
+ Start <command>mysqld</command> in the
+ <command>ddd</command> debugger.
+ </para>
</listitem>
<listitem>
@@ -1928,6 +2112,10 @@
<option>--debug</option>
</para>
+
+ <para>
+ Dump trace output for all clients and servers.
+ </para>
</listitem>
<listitem>
@@ -1994,10 +2182,10 @@
</para>
<para>
- 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.
+ Note: If a test case has an <filename>.opt</filename> file
+ that requires the server to be restarted with specific
+ options, the file will not be used. The test case likely
+ will fail as a result.
</para>
</listitem>
@@ -2015,6 +2203,10 @@
<option>--fast</option>
</para>
+
+ <para>
+ Do not clean up from earlier test runs.
+ </para>
</listitem>
<listitem>
@@ -2069,6 +2261,11 @@
<option>--gdb</option>
</para>
+
+ <para>
+ Start <command>mysqld</command> in the
+ <command>gdb</command> debugger.
+ </para>
</listitem>
<listitem>
@@ -2108,6 +2305,10 @@
tells <command>mysqltest</command> to use it. This is the
default as of MySQL 4.1.
</para>
+
+ <para>
+ [TODO: remove final sentence for .pl version]
+ </para>
</listitem>
<listitem>
@@ -2130,31 +2331,19 @@
<para>
<indexterm>
<primary>mysql-test-run</primary>
- <secondary>manager option</secondary>
+ <secondary>log-warnings option</secondary>
</indexterm>
<indexterm>
- <primary>manager option</primary>
+ <primary>log-warnings option</primary>
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--manager</option>
+ <option>--log-warnings</option>
</para>
- </listitem>
- <listitem>
<para>
- <indexterm>
- <primary>mysql-test-run</primary>
- <secondary>manager-port option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>manager-port option</primary>
- <secondary>mysql-test-run</secondary>
- </indexterm>
-
- <option>--manager-port=<replaceable>port_num</replaceable></option>
+ This option is a synonym for <option>--warnings</option>.
</para>
</listitem>
@@ -2172,6 +2361,11 @@
<option>--manual-gdb</option>
</para>
+
+ <para>
+ Use a server that has already been started by the user in
+ the <command>gdb</command> debugger.
+ </para>
</listitem>
<listitem>
@@ -2206,8 +2400,8 @@
</para>
<para>
- [Note the glitch that the option name has an underscore
- and not a dash (both versions)]
+ Observe that the option name has an underscore and not a
+ dash.
</para>
</listitem>
@@ -2307,8 +2501,7 @@
</para>
<para>
- [Note the glitch that the option name has an underscore
- and not a dash]
+ Observe that the option name contains an underscore.
</para>
</listitem>
@@ -2328,8 +2521,7 @@
</para>
<para>
- [Note the glitch that the option name has an underscore
- and not a dash]
+ Observe that the option name contains an underscore.
</para>
</listitem>
@@ -2337,22 +2529,6 @@
<para>
<indexterm>
<primary>mysql-test-run</primary>
- <secondary>ndbcluster-port-slave option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>ndbcluster-port-slave option</primary>
- <secondary>mysql-test-run</secondary>
- </indexterm>
-
- <option>--ndbcluster-port-slave=<replaceable>port_num</replaceable></option>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql-test-run</primary>
<secondary>ndbcluster-port option</secondary>
</indexterm>
@@ -2361,12 +2537,6 @@
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--ndbcluster-port=<replaceable>port_num</replaceable></option>
- </para>
- </listitem>
-
- <listitem>
- <para>
<indexterm>
<primary>mysql-test-run</primary>
<secondary>ndbcluster_port option</secondary>
@@ -2377,6 +2547,7 @@
<secondary>mysql-test-run</secondary>
</indexterm>
+ <option>--ndbcluster-port=<replaceable>port_num</replaceable></option>,
<option>--ndbcluster_port=<replaceable>port_num</replaceable></option>
</para>
</listitem>
@@ -2385,15 +2556,15 @@
<para>
<indexterm>
<primary>mysql-test-run</primary>
- <secondary>ndbd-extra-opts option</secondary>
+ <secondary>ndbcluster-port-slave option</secondary>
</indexterm>
<indexterm>
- <primary>ndbd-extra-opts option</primary>
+ <primary>ndbcluster-port-slave option</primary>
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--ndbd-extra-opts=<replaceable>str</replaceable></option>
+ <option>--ndbcluster-port-slave=<replaceable>port_num</replaceable></option>
</para>
</listitem>
@@ -2401,27 +2572,15 @@
<para>
<indexterm>
<primary>mysql-test-run</primary>
- <secondary>no-manager option</secondary>
+ <secondary>ndbd-extra-opts option</secondary>
</indexterm>
<indexterm>
- <primary>no-manager option</primary>
+ <primary>ndbd-extra-opts option</primary>
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--no-manager</option>,
-
- <indexterm>
- <primary>mysql-test-run</primary>
- <secondary>skip-manager option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>skip-manager option</primary>
- <secondary>mysql-test-run</secondary>
- </indexterm>
-
- <option>--skip-manager</option>
+ <option>--ndbd-extra-opts=<replaceable>str</replaceable></option>
</para>
</listitem>
@@ -2471,6 +2630,10 @@
<option>--purify</option>
</para>
+
+ <para>
+ Use the Purify memory-leak detector.
+ </para>
</listitem>
<listitem>
@@ -2609,8 +2772,9 @@
</para>
<para>
- Specify a regular expression that matches the names of
- tests to skip.
+ Specify a regular expression to be applied to test case
+ names. Cases with names that match the expression are
+ skipped. tests to skip.
</para>
</listitem>
@@ -2624,10 +2788,6 @@
by <command>mysql-test-run</command> are passed to the
master server.
</para>
-
- <para>
- [Q: is that true in the Perl version as well?]
- </para>
</listitem>
<listitem>
@@ -2662,8 +2822,8 @@
</para>
<para>
- [Note the glitch that the option name has an underscore
- and not a dash (both versions)]
+ Observe that the option name has an underscore and not a
+ dash.
</para>
</listitem>
@@ -2683,7 +2843,8 @@
</para>
<para>
- [Q: Passed to <command>mysqltest</command>?]
+ Pass <option>--sleep=<replaceable>N</replaceable></option>
+ to <command>mysqltest</command>.
</para>
</listitem>
@@ -2701,6 +2862,11 @@
<option>--small-bench</option>
</para>
+
+ <para>
+ Run the benchmarks with the <option>--small-tests</option>
+ and <option>--small-tables</option> options.
+ </para>
</listitem>
<listitem>
@@ -2717,6 +2883,12 @@
<option>--socket=<replaceable>file_name</replaceable></option>
</para>
+
+ <para>
+ For connections to <literal>localhost</literal>, the Unix
+ socket file to use, or, on Windows, the name of the named
+ pipe to use.
+ </para>
</listitem>
<listitem>
@@ -2733,6 +2905,11 @@
<option>--start-and-exit</option>
</para>
+
+ <para>
+ Initialize and start servers with the startup settings for
+ the specified test case or cases, if any, and then exit.
+ </para>
</listitem>
<listitem>
@@ -2752,7 +2929,7 @@
<para>
<command>mysql-test-run</command> sorts the list of names
- indicating which tests to run, and then begins with
+ of the test cases to be run, and then begins with
<replaceable>test_name</replaceable>.
</para>
</listitem>
@@ -2787,6 +2964,12 @@
<option>--stress</option>
</para>
+
+ <para>
+ Run the stress test. The other
+ <option>--stress-<replaceable>xxx</replaceable></option>
+ options apply in this case.
+ </para>
</listitem>
<listitem>
@@ -2812,7 +2995,6 @@
<replaceable>file_name</replaceable> is omitted, the
default file is <filename>stress-init.txt</filename> in
the stress suite base directory. [Q: Is that correct?]
- (See <option>--stress-suite-basedir</option>.)
</para>
</listitem>
@@ -2848,10 +3030,12 @@
</para>
<para>
- The stress test mode, either <literal>random</literal> to
- select tests in randome order or <literal>seq</literal> to
- run tests in each thread in the order specified in the
- test list file.
+ This option indicates the test order in stress-test mode.
+ The <replaceable>mode</replaceable> value is either
+ <literal>random</literal> to select tests in random order
+ or <literal>seq</literal> to run tests in each thread in
+ the order specified in the test list file. The default
+ mode is <literal>random</literal>.
</para>
</listitem>
@@ -2869,6 +3053,11 @@
<option>--stress-suite=<replaceable>suite_name</replaceable></option>
</para>
+
+ <para>
+ The name of the test suite to use for stress testing. The
+ default suite name is <literal>main</literal>.
+ </para>
</listitem>
<listitem>
@@ -2885,6 +3074,10 @@
<option>--stress-test-count=<replaceable>N</replaceable></option>
</para>
+
+ <remark role="note">
+ Default is 0
+ </remark>
</listitem>
<listitem>
@@ -2901,6 +3094,10 @@
<option>--stress-test-duration=<replaceable>N</replaceable></option>
</para>
+
+ <remark role="note">
+ Default is 0
+ </remark>
</listitem>
<listitem>
@@ -2917,6 +3114,10 @@
<option>--stress-test-file=<replaceable>file_name</replaceable></option>
</para>
+
+ <remark role="note">
+ Default is empty
+ </remark>
</listitem>
<listitem>
@@ -2933,6 +3134,10 @@
<option>--stress-threads=<replaceable>N</replaceable></option>
</para>
+
+ <remark role="note">
+ Default is 5
+ </remark>
</listitem>
<listitem>
@@ -3031,8 +3236,18 @@
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--valgrind</option>,
+ <option>--valgrind</option>
+ </para>
+ <para>
+ Run <command>mysqltest</command> and
+ <command>mysqld</command> with
+ <command>valgrind</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
<indexterm>
<primary>mysql-test-run</primary>
<secondary>valgrind-all option</secondary>
@@ -3045,6 +3260,13 @@
<option>--valgrind-all</option>
</para>
+
+ <para>
+ Like <option>--valgrind</option>, but passes the
+ <option>--verbose</option> and
+ <option>--show-reachable</option> options to
+ <command>valgrind</command>.
+ </para>
</listitem>
<listitem>
@@ -3059,8 +3281,17 @@
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--valgrind-mysqltest</option>,
+ <option>--valgrind-mysqltest</option>
+ </para>
+ <para>
+ Run <command>mysqltest</command> with
+ <command>valgrind</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
<indexterm>
<primary>mysql-test-run</primary>
<secondary>valgrind-mysqltest-all option</secondary>
@@ -3073,6 +3304,13 @@
<option>--valgrind-mysqltest-all</option>
</para>
+
+ <para>
+ Like <option>--valgrind-mysqltest</option>, but passes the
+ <option>--verbose</option> and
+ <option>--show-reachable</option> options to
+ <command>valgrind</command>.
+ </para>
</listitem>
<listitem>
@@ -3089,21 +3327,9 @@
<option>--valgrind-options=<replaceable>str</replaceable></option>
</para>
- </listitem>
- <listitem>
<para>
- <indexterm>
- <primary>mysql-test-run</primary>
- <secondary>verbose-manager option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>verbose-manager option</primary>
- <secondary>mysql-test-run</secondary>
- </indexterm>
-
- <option>--verbose-manager</option>
+ Extra options to pass to <command>valgrind</command>.
</para>
</listitem>
@@ -3135,19 +3361,7 @@
<secondary>mysql-test-run</secondary>
</indexterm>
- <option>--warnings</option>,
-
- <indexterm>
- <primary>mysql-test-run</primary>
- <secondary>log-warnings option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>log-warnings option</primary>
- <secondary>mysql-test-run</secondary>
- </indexterm>
-
- <option>--log-warnings</option>
+ <option>--warnings</option>
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2363 - in trunk: . mysqltest | paul | 13 Jun |
