Author: paul
Date: 2006-03-14 04:23:53 +0100 (Tue, 14 Mar 2006)
New Revision: 1570
Log:
r8644@frost: paul | 2006-03-13 21:22:13 -0600
General revisions.
Modified:
trunk/
trunk/mysqltest/command-reference.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:8640
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3817
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:8644
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3817
Modified: trunk/mysqltest/command-reference.xml
===================================================================
--- trunk/mysqltest/command-reference.xml 2006-03-13 21:36:07 UTC (rev 1569)
+++ trunk/mysqltest/command-reference.xml 2006-03-14 03:23:53 UTC (rev 1570)
@@ -42,36 +42,29 @@
<command>mysqltest</command>. The language allows input to contain a
mix of comments, commands executed by <command>mysqltest</command>
itself, and SQL statements that <command>mysqltest</command> sends
- to a MySQL server for execution. Here is an example of input for
- <command>mysqltest</command>:
+ to a MySQL server for execution.
</para>
-<programlisting>
-# this is a comment that is ignored
--- this is a comment because it does not begin with a command word
--- echo this is a mysqltest command because it begins with a command word
-select 'this is a SQL statement to be sent to the server';
-echo this is a mysqltest command because it begins with a command word;
-</programlisting>
-
<para>
- When <command>mysqltest</command> starts, it opens a connection
- named <literal>default</literal>, using any connection parameters
- specified by the command options. [Q: When run from
- <command>mysql-test-run</command>, the default username will be
- <literal>root</literal>?]
+ <emphasis role="bold">Terminology note:</emphasis>
</para>
<para>
- You can use the <literal>connection</literal> command to open other
- connections, the <literal>connection</literal> command to switch
- between connections, and the <literal>disconnect</literal> command
- to close connections. The capability for switching connections which
- means that <literal>default</literal> need not be the connection in
- use at a given time. To avoid ambiguity, this document uses the term
- <quote>current connection</quote> to indicate the connection
- currently in use, which might be different from <quote>the
- connection named <literal>default</literal>.</quote>
+ When <command>mysqltest</command> starts, it opens a connection
+ named <literal>default</literal> to the MySQL server, using any
+ connection parameters specified by the command options. [Q: When run
+ from <command>mysql-test-run</command>, the default username will be
+ <literal>root</literal>?] You can use the <literal>connect</literal>
+ command to open other connections, the <literal>connection</literal>
+ command to switch between connections, and the
+ <literal>disconnect</literal> command to close connections. However,
+ the capability for switching connections means that
+ <literal>default</literal> need not be the connection in use at a
+ given time. To avoid ambiguity, this document avoids the term
+ <quote>default connection.</quote> It uses the term <quote>current
+ connection</quote> to mean <quote>the connection currently in
+ use,</quote> which might be different from <quote>the connection
+ named <literal>default</literal>.</quote>
</para>
<section id="mysqltest-input-conventions">
@@ -98,8 +91,8 @@
<listitem>
<para>
A line that begins with ‘<literal>#</literal>’ as
- the first non-whitespace character is treated as a comment
- that extends to the end of the line and is ignored. Example:
+ the first non-whitespace content is treated as a comment that
+ extends to the end of the line and is ignored. Example:
</para>
<programlisting>
@@ -115,13 +108,38 @@
‘<literal>#</literal>’ comments, if the first word
of the comment is a valid <command>mysqltest</command>
command, <command>mysqltest</command> executes the line from
- that word to the end of the line as a command. This syntax is
- useful for writing commands that contain embedded instances of
- the command delimiter. Examples:
+ that word to the end of the line as a command.
</para>
+ <para>
+ <command>mysqltest</command> interprets these lines as
+ comments because the first word is not a
+ <command>mysqltest</command> command:
+ </para>
+
<programlisting>
+-- this is a comment
+-- clean up from previous test runs
+</programlisting>
+
+ <para>
+ <command>mysqltest</command> interprets these lines as
+ commands and executes them because the first word is a
+ <command>mysqltest</command> command:
+ </para>
+
+<programlisting>
--disconnect conn1
+-- error 1050
+</programlisting>
+
+ <para>
+ The ‘<literal>--</literal>’ syntax is useful for
+ writing commands that contain embedded instances of the
+ command delimiter:
+ </para>
+
+<programlisting>
-- echo write this text; it goes to the result file
</programlisting>
</listitem>
@@ -136,48 +154,48 @@
</para>
<para>
- Because the command extends to the delimiter, a given input
- line can contain multiple commands, and a given command can
- span multiple lines. If the first line of the
- delimiter-terminated command begins with a word that is a
- <command>mysqltest</command> command,
- <command>mysqltest</command> executes it as such. Otherwise,
- <command>mysqltest</command> assumes that the command is an
- SQL statement and sends it to the MySQL server to be executed.
+ If <command>mysqltest</command> recognizes the first word of
+ the delimiter-terminated command, <command>mysqltest</command>
+ executes the command itself. Otherwise,
+ <command>mysqltest</command> assumes that the command is
+ really an SQL statement and sends it to the MySQL server to be
+ executed.
</para>
<para>
- After <command>mysqltest</command> reads a command up to a
- delimiter and executes it, input reading restarts following
- the delimiter and any following input on the line that
- contains the delimiter is treated as though it begins on a new
- line. Consider the following two input lines:
+ Because the command extends to the delimiter, a given input
+ line can contain multiple commands, and a given command can
+ span multiple lines. After <command>mysqltest</command> reads
+ a command up to a delimiter and executes it, input reading
+ restarts following the delimiter and any following input on
+ the line that contains the delimiter is treated as though it
+ begins on a new line. Consider the following two input lines:
</para>
<programlisting>
-select 1; select 'hello'; select
-'goodbye';
+echo issue a select statement; select 1; echo done
+issuing the select statement;
</programlisting>
<para>
- Three separate commands result from that input:
+ That input contains two commands and one SQL statement:
</para>
<programlisting>
+echo issue a select statement
select 1
-select 'hello'
-select 'goodbye'
+echo done issuing the select statement
</programlisting>
<para>
Similarly, ‘<literal>#</literal>’ comments or
- ‘<literal>--</literal>’ comments can be given on a
+ ‘<literal>--</literal>’ comments can begin on a
command line following a delimiter:
</para>
<programlisting>
select 'hello'; # select a string value
-select 'hello'; -- echo some text
+select 'hello'; -- echo that was a select statement
</programlisting>
<para>
@@ -249,35 +267,66 @@
</programlisting>
<para>
- [Ambiguity] Although it is <emphasis>possible</emphasis> to write
- a non-command comment that begins with
+ The input language has certain ambiguities. For example, if you
+ write the following line, intending it as a comment that indicates
+ where test 43 ends, it will not work:
+ </para>
+
+<programlisting>
+-- End of test 43
+</programlisting>
+
+ <para>
+ The <quote>comment</quote> is not treated as such because
+ <literal>end</literal> is a valid <command>mysqltest</command>
+ command. Thus, although it is <emphasis>possible</emphasis> to
+ write a non-command comment that begins with
‘<literal>--</literal>’, it is better to use
- ‘<literal>#</literal>’ instead. For example, the line
- <literal>--switch to conn1</literal> is take as a comment
- currently, but if <command>mysqltest</command> is extended in the
- future to add a <literal>switch</literal> command, that line will
- be treated as a command instead. If you use
- ‘<literal>#</literal>’ for all comments, this problem
- will not occur.
+ ‘<literal>#</literal>’ instead. Writing comments with
+ ‘<literal>#</literal>’ also has less potential to
+ cause problems in the future. For example,
+ <command>mysqltest</command> interprets the line <literal>--switch
+ to conn1</literal> as a comment currently, but if
+ <command>mysqltest</command> is extended in the future to add a
+ <literal>switch</literal> command, that line will be treated as a
+ command instead. If you use ‘<literal>#</literal>’ for
+ all comments, this problem will not occur.
</para>
<para>
- [Ambiguity] Because a non-comment line can contain either a
- <command>mysqltest</command> command or an SQL statement,
- presumably this means that no <command>mysqltest</command> command
- should be the same as any keyword that can begin an SQL statement?
- Presumably also this means that, should extensions to SQL be
- implemented in the future, it's possible that a new SQL keyword
- could be impossible for <command>mysqltest</command> to recognize
- as such if that keyword is already used as a
- <command>mysqltest</command> command.
+ Another ambiguity occurs because a non-comment line can contain
+ either a <command>mysqltest</command> command or an SQL statement.
+ This has a couple of implications:
</para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ No <command>mysqltest</command> command should be the same as
+ any keyword that can begin an SQL statement.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Should extensions to SQL be implemented in the future, it's
+ possible that a new SQL keyword could be impossible for
+ <command>mysqltest</command> to recognize as such if that
+ keyword is already used as a <command>mysqltest</command>
+ command.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
On a multiple-line command, ‘<literal>#</literal>’ or
‘<literal>--</literal>’ at the beginning of the second
or following lines is not special. Thus, the second and third
- lines of the following command are not taken as comments:
+ lines of the following variable-assignment command are not taken
+ as comments. Instead, the variable <literal>$a</literal> is set to
+ a value that contains two linefeed characters:
</para>
<programlisting>
@@ -287,12 +336,12 @@
</programlisting>
<para>
- Describe quoting and escaping rules. How to include a literal
- quote? Double it? Escape it? Can you escape a delimiter as "\;"?
- But then what if the delimiter is multiple characters? (I guess
- that wouldn't matter. If the first char is not taken as a
+ [TODO: Describe quoting and escaping rules. How to include a
+ literal quote? Double it? Escape it? Can you escape a delimiter as
+ "\;"? But then what if the delimiter is multiple characters? (I
+ guess that wouldn't matter. If the first char is not taken as a
delimiter beginning, the rest wouldn't be recognized, either.
- Escaping appears to be allowable only in limited contexts?
+ Escaping appears to be allowable only in limited contexts?]
</para>
</section>
@@ -358,9 +407,11 @@
<listitem>
<para>
<replaceable>name</replaceable> is the name for the
- connection (for use with the <literal>connection</literal>
- and <literal>disconnect</literal> commands). This name
- must not already be in use by an open connection.
+ connection (for use with the
+ <literal>connection</literal>,
+ <literal>disconnect</literal>, and
+ <literal>dirty_close</literal> commands). This name must
+ not already be in use by an open connection.
</para>
</listitem>
@@ -432,9 +483,10 @@
<para>
[BUG: leaving off the trailing parenthesis can produce a weird
- error. For example, with no paren after the database name,
- <command>mysqltest</command> says <literal>mysqltest: At line
- 1: Illegal argument for port: 'h4z'</literal>.]
+ error. For example, with no parenthesis after the database
+ name, <command>mysqltest</command> produces this error
+ message: <literal>mysqltest: At line 1: Illegal argument for
+ port: 'h4z'</literal>.]
</para>
</listitem>
@@ -477,14 +529,18 @@
<para>
[Q: The Wiki docs state a max length of 16, but that doesn't
- work; perhaps this is a bug? Or else MAX_DELIMITER includes
- the terminating null byte?]
+ 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>
</listitem>
<listitem>
@@ -520,8 +576,8 @@
<literal>disable_abort_on_error</literal> also to suppress
aborts for a statement that succeeds when it shouldn't, or a
statement that fails with an error different from that
- specified as expected.. But <command>mysqltest</command>
- aborts regardless.]
+ specified as expected. But <command>mysqltest</command> aborts
+ regardless.]
</para>
<para>
@@ -556,7 +612,7 @@
<para>
Disable or enable query metadata display. This setting is
- enabled by default. With this setting enabled,
+ disabled by default. With this setting enabled,
<command>mysqltest</command> adds query metadata to the
result. This information consists of the values corresponding
to the members of the <literal>MYSQL_FIELD</literal> C API
@@ -571,8 +627,8 @@
</para>
<para>
- Increment or decrement the parsing-disabled level. The level
- is 0 by default.
+ Disable or enable query parsing. This setting is enabled by
+ default.
</para>
<para>
@@ -643,7 +699,8 @@
</para>
<para>
- [Q: When does this apply? To connections made afterward?]
+ [Q: When does this command apply? To connections made
+ afterward?]
</para>
</listitem>
Modified: trunk/mysqltest/mysqltest.xml
===================================================================
--- trunk/mysqltest/mysqltest.xml 2006-03-13 21:36:07 UTC (rev 1569)
+++ trunk/mysqltest/mysqltest.xml 2006-03-14 03:23:53 UTC (rev 1570)
@@ -95,29 +95,34 @@
<listitem>
<para>
- The <command>mysql-test-run</command> script is used to run
- the test suite.
+ The <command>mysql-test-run</command> shell script is the main
+ application used to run the test suite. It invokes
+ <command>mysqltest</command> to run individual test cases.
</para>
</listitem>
<listitem>
<para>
- The <command>mysql-test-run.pl</command> script is currently
- in development (and eventually will replace
- <command>mysql-test-run</command>).
+ The <command>mysql-test-run.pl</command> Perl script is
+ currently in development to serve as a replacement for
+ <command>mysql-test-run</command>.
</para>
</listitem>
<listitem>
<para>
- <command>mysqltest</command> runs a test case.
+ <command>mysqltest</command> runs test cases. A version named
+ <command>mysqltest_embedded</command> is similar but is built
+ with support for the <literal>libmysqld</literal> embedded
+ server.
</para>
</listitem>
<listitem>
<para>
- The <command>mysql-stress-test.pl</command> script is used for
- stress-testing. (MySQL 5.0 and up only)
+ The <command>mysql-stress-test.pl</command> Perl script
+ performs stress-testing of the MySQL server. (MySQL 5.0 and up
+ only)
</para>
</listitem>
@@ -155,7 +160,8 @@
<listitem>
<para>
- The <command>mysql-test-run</command> and
+ The <command>mysql-test-run</command>, The
+ <command>mysql-test-run.pl</command>, and
<command>mysql-stress-test.pl</command> programs that are used
for running tests.
</para>
@@ -194,7 +200,7 @@
<para>
[Q: Is the -master.opt file used for the "main" server in
- a test, even if no replication is involved.
+ a test, even if no replication is involved?]
</para>
</listitem>
@@ -253,20 +259,6 @@
<filename><replaceable>test_name</replaceable>.reject</filename>
contains output for the named test case if the test fails.
</para>
-
- <para>
- [Q: If a <filename>.reject</filename> file is created
- because a test fails, does the file get removed
- automatically later the next time the test succeeds?]
- </para>
-
- <para>
- [Q: <command>mysql-test-run</command> refers to
- <filename>.eval</filename> files. What are these for? Do
- they result from the <literal>eval_result</literal>
- command and if they exist they are used instead of the
- corresponding <filename>.result</filename> files?
- </para>
</listitem>
</itemizedlist>
@@ -279,6 +271,20 @@
result, and the <filename>.reject</filename> file represents
the actual result.
</para>
+
+ <para>
+ [Q: If a <filename>.reject</filename> file is created because
+ a test fails, does <command>mysql-test-run</command> remove
+ the file automatically later the next time the test succeeds?]
+ </para>
+
+ <para>
+ [Q: <command>mysql-test-run</command> refers to
+ <filename>.eval</filename> files. What are these for? Do they
+ result from the <literal>eval_result</literal> command and if
+ they exist they are used instead of the corresponding
+ <filename>.result</filename> files?]
+ </para>
</listitem>
<listitem>
@@ -306,7 +312,7 @@
<listitem>
<para>
- The <filename>var</filename> directory is used turning test
+ 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.
</para>
@@ -343,28 +349,22 @@
<listitem>
<para>
- Input SQL statements and their output. That is, each statement
- is written to the result followed by its output.
+ Input SQL statements and their output. Each statement is
+ written to the result followed by its output. Columns in
+ output resulting from SQL statements are separated by tab
+ characters.
</para>
</listitem>
<listitem>
<para>
The result from <command>mysqltest</command> commands such as
- <literal>echo</literal> and <literal>exec</literal>. That is,
- the commands themselves are not echoed to the result, only
- their output.
+ <literal>echo</literal> and <literal>exec</literal>. The
+ commands themselves are not echoed to the result, only their
+ output.
</para>
</listitem>
- <listitem>
- <para>
- Columns in output resulting from SQL statements are separated
- by tab characters. [Q: Is there any way to change the
- separator?]
- </para>
- </listitem>
-
</itemizedlist>
<para>
@@ -377,11 +377,12 @@
<para>
[Q: I believe the _result_log commands affect not just normal
- statement output, but also warning or error messages.] [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.]
+ 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?]
</para>
<para>
@@ -453,7 +454,7 @@
<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
- files in those directories is a convention followed by
+ files in those directories is a convention that is used by
<command>mysql-test-run</command>, which invokes
<command>mysqltest</command> with the appropriate options for each
test case to tell <command>mysqltest</command> where to read input
@@ -462,7 +463,7 @@
<para>
[TODO: would be useful to have an example command line here
- showning how <command>mysql-test-run</command> invokes
+ showing how <command>mysql-test-run</command> invokes
<command>mysqltest</command>.]
</para>
@@ -493,32 +494,34 @@
<listitem>
<para>
- <command>mysqltest</command> runs individual test cases. A
- version named <command>mysqltest_embedded</command> is similar
- but is build with support for the <literal>libmysqld</literal>
- embedded server.
+ The <command>mysql-test-run</command> shell script is the main
+ application used to run the test suite. It invokes
+ <command>mysqltest</command> to run individual test cases.
</para>
</listitem>
<listitem>
<para>
- <command>mysql-test-run</command> (a shell script) uses
- <command>mysqltest</command> to run a suite of test cases.
+ The <command>mysql-test-run.pl</command> Perl script is
+ currently in development to serve as a replacement for
+ <command>mysql-test-run</command>.
</para>
</listitem>
<listitem>
<para>
- <command>mysql-test-run.pl</command> (a Perl script) is
- currently in development as a replacement for
- <command>mysql-test-run</command>.
+ <command>mysqltest</command> runs test cases. A version named
+ <command>mysqltest_embedded</command> is similar but is built
+ with support for the <literal>libmysqld</literal> embedded
+ server.
</para>
</listitem>
<listitem>
<para>
- <command>mysql-stress-test.pl</command> performs
- stress-testing of the MySQL server.
+ The <command>mysql-stress-test.pl</command> Perl script
+ performs stress-testing of the MySQL server. (MySQL 5.0 and up
+ only)
</para>
</listitem>
@@ -561,11 +564,10 @@
<title>Description</title>
<para>
- The <command>mysqltest</command> program runs
- <command>mysqltest</command> runs a test case against a
- MySQL server and optionally compares the output with a
- result file. This program reads input written in a special
- test language. Typically, you invoke
+ The <command>mysqltest</command> program runs a test case
+ against a MySQL server and optionally compares the output
+ with a result file. This program reads input written in a
+ special test language. Typically, you invoke
<command>mysqltest</command> via
<command>mysql-test-run</command> rather than invoking it
directly.
@@ -581,7 +583,7 @@
<para>
Can send statements to MySQL servers for execution or
execute shell commands, and test whether the result is
- as expected.
+ as expected
</para>
</listitem>
@@ -589,7 +591,7 @@
<para>
Can connect to one or more standalone
<command>mysqld</command> servers and switch between
- connections.
+ connections
</para>
</listitem>
@@ -597,7 +599,7 @@
<para>
Can connect to an embedded server
(<literal>libmysqld</literal>), if MySQL is compiled
- with support for <literal>libmysqld</literal>.
+ with support for <literal>libmysqld</literal>
</para>
</listitem>
@@ -709,7 +711,7 @@
</para>
<para>
- Define the <command>mysqlcommand</command> variable
+ Define the <command>mysqltest</command> variable
<literal>$BIG_TEST</literal> as 1.
</para>
</listitem>
@@ -791,8 +793,7 @@
</indexterm>
<option>--debug[=<replaceable>debug_options</replaceable>]</option>,
- <option>-#
- [<replaceable>debug_options</replaceable>]</option>
+ <option>-#[<replaceable>debug_options</replaceable>]</option>
</para>
<para>
@@ -1299,10 +1300,11 @@
<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 that as the "no setting given" value,
- and preventing negative values from being given on the
- command line by using GET_UINT (not GET_INT) in the
- option structure.]
+ (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."]
</para>
</listitem>
@@ -1550,8 +1552,9 @@
<title>Description</title>
<para>
- <command>mysql-test-run</command> invokes
- <command>mysqltest</command> to run test cases.
+ <command>mysql-test-run</command> is the main application
+ that is used to run the test suite. It invokes
+ <command>mysqltest</command> to run individual test cases.
</para>
<para>
@@ -1577,8 +1580,8 @@
<para>
Each <replaceable>test_name</replaceable> argument names a
- test case. The test case file corresponding to the test name
- is
+ test case. The test case file that corresponds to the test
+ name is
<filename>t/<replaceable>test_name</replaceable>.test</filename>.
</para>
@@ -1592,6 +1595,16 @@
</para>
<para>
+ The
+ <option>--do-tests=<replaceable>prefix</replaceable></option>
+ option can be used to run a family of similarly named test
+ cases that are named beginning with
+ <replaceable>prefix</replaceable>. For example,
+ <option>--do-tests=rpl</option> runs the replication test
+ cases.
+ </para>
+
+ <para>
<command>mysql-test-run</command> appears to define some
environment variables:
</para>
@@ -1618,7 +1631,7 @@
<row>
<entry><literal>MYSQL_TEST_WINDIR</literal></entry>
<entry>Pathname to the <filename>mysql-test</filename> directory on Windows [Q:
- ???]</entry>
+ Is that correct]</entry>
</row>
<row>
<entry><literal>MYSQLTEST_VARDIR</literal></entry>
@@ -1646,7 +1659,7 @@
<para>
Some tests rely on certain environment variables being
defined. For example, some tests assume that
- <literal>MYSQL_TEST</literal> is defined, so that
+ <literal>MYSQL_TEST</literal> is defined so that
<command>mysqltest</command> can invoke itself with
<literal>exec $MYSQL_TEST</literal>.
</para>
@@ -1664,15 +1677,12 @@
</para>
<para>
- The <command>mysql-test-run</command> program invokes the
- <command>mysqltest</command> program to run a test case.
- </para>
-
- <para>
<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.
+ following arguments as options. [Q: Does
+ <literal>--</literal> also have that effect for
+ <command>mysql-test-run.pl</command>?]
</para>
<itemizedlist>
@@ -1700,9 +1710,9 @@
[BUG: In fact, <command>mysql-test-run</command> does
not have a <option>--help</option> option. That is a
deficiency that is corrected in
- <command>mysql-test-run.pl</command>, but there is no
- runtime command for <command>mysql-test-run</command> to
- discover its options.]
+ <command>mysql-test-run.pl</command>, but for
+ <command>mysql-test-run</command> there is no runtime
+ command that you can use to discover its options.]
</para>
</listitem>
@@ -1739,7 +1749,7 @@
<para>
Pass the <option>--big-test</option> option to
- <command>mysql-test</command>.
+ <command>mysqltest</command>.
</para>
</listitem>
@@ -1837,6 +1847,13 @@
<option>--do-test=<replaceable>prefix</replaceable></option>
</para>
+
+ <para>
+ Run all test cases having a name that begins with the
+ given <replaceable>prefix</replaceable> value. This
+ option provides a convenient way to run a family of
+ similarly named tests.
+ </para>
</listitem>
<listitem>
@@ -1987,8 +2004,9 @@
</para>
<para>
- [Q: So what does this mean? Tell
- <command>mysqltest</command> to start its own server?]
+ [Q: So what does this mean?
+ <command>mysql-run-test</command> starts a server and
+ tells <command>mysqltest</command> to use it?]
</para>
</listitem>
@@ -2086,6 +2104,11 @@
<option>--master_port=<replaceable>port_num</replaceable></option>
</para>
+
+ <para>
+ [Note the glitch that the option name has an underscore
+ and not a dash]
+ </para>
</listitem>
<listitem>
@@ -2182,6 +2205,11 @@
<option>--ndb_mgm-extra-opts=<replaceable>str</replaceable></option>
</para>
+
+ <para>
+ [Note the glitch that the option name has an underscore
+ and not a dash]
+ </para>
</listitem>
<listitem>
@@ -2198,6 +2226,11 @@
<option>--ndb_mgmd-extra-opts=<replaceable>str</replaceable></option>
</para>
+
+ <para>
+ [Note the glitch that the option name has an underscore
+ and not a dash]
+ </para>
</listitem>
<listitem>
@@ -2520,6 +2553,11 @@
<option>--slave_port=<replaceable>port_num</replaceable></option>
</para>
+
+ <para>
+ [Note the glitch that the option name has an underscore
+ and not a dash]
+ </para>
</listitem>
<listitem>
@@ -3058,11 +3096,6 @@
</itemizedlist>
- <para>
- [Fill in this section with all
- <command>mysql-test-run</command> options]
- </para>
-
</refsection>
</refentry>
@@ -3106,7 +3139,9 @@
<title>Description</title>
<para>
- [Fill in]
+ The <command>mysql-test-run.pl</command> Perl script is
+ currently in development to serve as a replacement for
+ <command>mysql-test-run</command>.
</para>
<para>
@@ -3126,8 +3161,8 @@
<para>
[Because the options for the Perl script are so similar to
those for the shell script, just describe here by referring
- to <command>mysql-test-run</command>, plus noting which
- options have been dropped and which added in
+ to the option list for <command>mysql-test-run</command>,
+ and note which options have been dropped and which added in
<command>mysql-test-run.pl</command>.
</para>
@@ -3162,7 +3197,8 @@
<para>
[Fill in this section with all
- <command>mysql-test-run.pl</command> options]
+ <command>mysql-test-run.pl</command> options, that
+ <command>mysql-test-run</command> does not have]
</para>
</refsection>
@@ -3208,12 +3244,14 @@
<title>Description</title>
<para>
- [Fill in]
+ The <command>mysql-stress-test.pl</command> Perl script
+ performs stress-testing of the MySQL server. (MySQL 5.0 and
+ up only)
</para>
<para>
- This program requires a version of Perl that has been built
- with threads support.
+ The <command>mysql-stress-test.pl</command> program requires
+ a version of Perl that has been built with threads support.
</para>
<para>
Modified: trunk/mysqltest/tutorial.xml
===================================================================
--- trunk/mysqltest/tutorial.xml 2006-03-13 21:36:07 UTC (rev 1569)
+++ trunk/mysqltest/tutorial.xml 2006-03-14 03:23:53 UTC (rev 1570)
@@ -149,10 +149,9 @@
</programlisting>
<para>
- By default, <command>mysql-test-run</command> terminates if any
- test case fails. Use the <option>--force</option> option if you
- want <command>mysql-test-run</command> to continue running later
- test cases even if earlier cases fail.
+ Normally, <command>mysql-test-run</command> exits if a test case
+ fails. <option>--force</option> causes execution to continue
+ regardless of test case failure.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1570 - in trunk: . mysqltest | paul | 14 Mar |
