Author: paul
Date: 2009-01-14 04:44:26 +0100 (Wed, 14 Jan 2009)
New Revision: 13159
Log:
r37294@frost: paul | 2009-01-13 20:32:29 -0500
mysqltest manual: Sun ESG conformance
Modified:
trunk/mysqltest/command-reference.xml
trunk/mysqltest/components.xml
trunk/mysqltest/programs.xml
trunk/mysqltest/running-tests.xml
trunk/mysqltest/writing-tests.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:41130
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:37292
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:35643
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:41130
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:37294
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:35643
Modified: trunk/mysqltest/command-reference.xml
===================================================================
--- trunk/mysqltest/command-reference.xml 2009-01-14 03:28:05 UTC (rev 13158)
+++ trunk/mysqltest/command-reference.xml 2009-01-14 03:44:26 UTC (rev 13159)
Changed blocks: 17, Lines Added: 24, Lines Deleted: 24; 7475 bytes
@@ -38,8 +38,8 @@
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. (For a
- local server, the default username is <literal>root</literal>.
- For an external server, the default username is
+ local server, the default user name is <literal>root</literal>.
+ For an external server, the default user name is
<literal>test</literal> or the user specified with the
<option>--user</option> option.) You can use the
<literal>connect</literal> command to open other connections,
@@ -380,8 +380,8 @@
<literal>append_file</literal> is like
<literal>write_file</literal> except that the lines up to the
terminator are added to the end of the file. The file is
- created if it does not exist. The filename argument is subject
- to variable substitution.
+ created if it does not exist. The file name argument is
+ subject to variable substitution.
</para>
<programlisting>
@@ -418,7 +418,7 @@
<para>
<literal>cat_file</literal> writes the contents of the file to
- the output. The filename argument is subject to variable
+ the output. The file name argument is subject to variable
substitution.
</para>
@@ -481,9 +481,9 @@
<para>
Change the mode of the given file. The file mode must be given
- as a four-digit octal number. The filename argument is subject
- to variable substitution, but must evaluate to a literal
- filename, not a filename pattern.
+ as a four-digit octal number. The file name argument is
+ subject to variable substitution, but must evaluate to a
+ literal file name, not a file name pattern.
</para>
<programlisting>
@@ -542,7 +542,7 @@
<listitem>
<para>
<replaceable>user_name</replaceable> and
- <replaceable>password</replaceable> are the username and
+ <replaceable>password</replaceable> are the user name and
password of the MySQL account to use.
</para>
</listitem>
@@ -643,8 +643,8 @@
<para>
Copy the file <replaceable>from_file</replaceable> to the file
<replaceable>to_file</replaceable>. The command fails if
- <replaceable>to_file</replaceable> already exists. The
- filename arguments are subject to variable substitution.
+ <replaceable>to_file</replaceable> already exists. The file
+ name arguments are subject to variable substitution.
</para>
<para>
@@ -732,7 +732,7 @@
<para>
Compare the two files. The command succeeds if the files are
the same, and fails if they are different or either file does
- not exist. The filename arguments are subject to variable
+ not exist. The file name arguments are subject to variable
substitution.
</para>
@@ -1271,7 +1271,7 @@
<note>
<para>
<literal>exec</literal> or <literal>system</literal> are
- sometimes used to perform filesystem operations, but the
+ sometimes used to perform file system operations, but the
command for doing so tend to be operating system specifc,
which reduces test portability. <command>mysqltest</command>
now has several commands to perform these operations
@@ -1304,7 +1304,7 @@
<para>
<literal>file_exists</literal> succeeds if the name file
- exists and fails otherwise. The filename argument is subject
+ exists and fails otherwise. The file name argument is subject
to variable substitution.
</para>
@@ -1690,9 +1690,9 @@
<para>
<literal>remove_file</literal> removes the file. It fails with
- an error if the file does not exist. The filename argument is
+ an error if the file does not exist. The file name argument is
subject to variable substitution, but must evaluate to a
- literal filename, not a filename pattern.
+ literal file name, not a file name pattern.
</para>
<programlisting>
@@ -1932,8 +1932,8 @@
<para>
For a master replication server, save the current binary log
- filename and position. These values can be used for subsequent
- <literal>sync_with_master</literal> or
+ file name and position. These values can be used for
+ subsequent <literal>sync_with_master</literal> or
<literal>sync_slave_with_master</literal> commands.
</para>
</listitem>
@@ -2197,7 +2197,7 @@
</para>
<para>
- Normally, the filename in the <literal>source</literal>
+ Normally, the file name in the <literal>source</literal>
command is relative to the <filename>mysql-test</filename>
directory because <command>mysqltest</command> usually is
invoked in that directory.
@@ -2215,7 +2215,7 @@
</programlisting>
<para>
- As of MySQL 4.1.24, 5.0.50, and 5.1.21, the filename can
+ As of MySQL 4.1.24, 5.0.50, and 5.1.21, the file name can
include variable references. Variables are expanded including
any quotes in the values, so normally the values should not
include quotes. Suppose that <filename>/tmp/junk</filename>
@@ -2228,7 +2228,7 @@
<para>
The following example shows one way in which variable
- references could be used to specify the filename:
+ references could be used to specify the file name:
</para>
<programlisting>
@@ -2275,7 +2275,7 @@
<para>
The effect is to save the replication coordinates (binary log
- filename and position) for the server on the current
+ file name and position) for the server on the current
connection (which is assumed to be a master replication
server), and then switch to a slave server and wait until it
catches up with the saved coordinates. Note that this command
@@ -2341,7 +2341,7 @@
<note>
<para>
<literal>exec</literal> or <literal>system</literal> are
- sometimes used to perform filesystem operations, but the
+ sometimes used to perform file system operations, but the
command for doing so tend to be operating system specifc,
which reduces test portability. <command>mysqltest</command>
now has several commands to perform these operations
@@ -2428,7 +2428,7 @@
Write the following lines of the test file to the given file,
until a line containing the terminator is encountered. The
default terminator is <literal>EOF</literal>, but a different
- terminator can be provided. The filename argument is subject
+ terminator can be provided. The file name argument is subject
to variable substitution. An error occurs if the file already
exists.
</para>
Modified: trunk/mysqltest/components.xml
===================================================================
--- trunk/mysqltest/components.xml 2009-01-14 03:28:05 UTC (rev 13158)
+++ trunk/mysqltest/components.xml 2009-01-14 03:44:26 UTC (rev 13159)
Changed blocks: 6, Lines Added: 6, Lines Deleted: 6; 2079 bytes
@@ -146,7 +146,7 @@
<listitem>
<para>
- A filename of the form
+ A file name of the form
<filename><replaceable>test_name</replaceable>.test</filename>
is a test case file for a test named
<replaceable>test_name</replaceable>. For example,
@@ -157,7 +157,7 @@
<listitem>
<para>
- A filename of the form
+ A file name of the form
<filename><replaceable>test_name</replaceable>-master.opt</filename>
provides options to associate with the named test case.
<literal>mysql-test-run.pl</literal> restarts the server
@@ -175,7 +175,7 @@
<listitem>
<para>
- A filename of the form
+ A file name of the form
<filename><replaceable>test_name</replaceable>-slave.opt</filename>
provides slave options.
</para>
@@ -183,7 +183,7 @@
<listitem>
<para>
- A filename of the form
+ A file name of the form
<filename><replaceable>test_name</replaceable>-im.opt</filename>
provides Instance Manager options.
</para>
@@ -247,7 +247,7 @@
<listitem>
<para>
- A filename of the form
+ A file name of the form
<filename><replaceable>test_name</replaceable>.result</filename>
is the expected result for the named test case. A file
<filename>r/<replaceable>test_name</replaceable>.result</filename>
@@ -259,7 +259,7 @@
<listitem>
<para>
- A filename of the form
+ A file name of the form
<filename><replaceable>test_name</replaceable>.reject</filename>
contains output for the named test case if the test fails.
</para>
Modified: trunk/mysqltest/programs.xml
===================================================================
--- trunk/mysqltest/programs.xml 2009-01-14 03:28:05 UTC (rev 13158)
+++ trunk/mysqltest/programs.xml 2009-01-14 03:44:26 UTC (rev 13159)
Changed blocks: 5, Lines Added: 6, Lines Deleted: 6; 1642 bytes
@@ -991,7 +991,7 @@
</para>
<para>
- The MySQL username to use when connecting to the server.
+ The MySQL user name to use when connecting to the server.
</para>
</listitem>
@@ -1445,7 +1445,7 @@
</para>
<para>
- The MySQL username to use when connecting to the server.
+ The MySQL user name to use when connecting to the server.
</para>
</listitem>
@@ -3720,7 +3720,7 @@
</para>
<para>
- The MySQL username to use when connecting to the server.
+ The MySQL user name to use when connecting to the server.
</para>
</listitem>
@@ -4344,7 +4344,7 @@
</para>
<para>
- The hostname of the local host to use for making a TCP/IP
+ The host name of the local host to use for making a TCP/IP
connection to the local server. By default, the connection
is made to <literal>localhost</literal> using a Unix socket
file.
@@ -4454,8 +4454,8 @@
</para>
<para>
- The MySQL username to use when connecting to the server. The
- default is <literal>root</literal>.
+ The MySQL user name to use when connecting to the server.
+ The default is <literal>root</literal>.
</para>
</listitem>
Modified: trunk/mysqltest/running-tests.xml
===================================================================
--- trunk/mysqltest/running-tests.xml 2009-01-14 03:28:05 UTC (rev 13158)
+++ trunk/mysqltest/running-tests.xml 2009-01-14 03:44:26 UTC (rev 13159)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 759 bytes
@@ -69,7 +69,7 @@
<filename>t/<replaceable>test_name</replaceable>.test</filename>,
where <replaceable>test_name</replaceable> is the name of the test
case, but each name given on the command line should be the test
- case name, not the full test case filename. The following command
+ case name, not the full test case file name. The following command
runs the test case named <literal>rpl_abcd</literal>, which has a
test file of <filename>t/rpl_abcd.test</filename>:
</para>
Modified: trunk/mysqltest/writing-tests.xml
===================================================================
--- trunk/mysqltest/writing-tests.xml 2009-01-14 03:28:05 UTC (rev 13158)
+++ trunk/mysqltest/writing-tests.xml 2009-01-14 03:44:26 UTC (rev 13159)
Changed blocks: 5, Lines Added: 15, Lines Deleted: 14; 3423 bytes
@@ -216,14 +216,14 @@
<title>File Naming and Organization Guidelines</title>
<para>
- Test case filenames should be lowercase ASCII with no spaces.
+ Test case file names should be lowercase ASCII with no spaces.
</para>
<para>
We are adding support for multiple test <quote>suites.</quote>
Until then, all test cases must be located in the
- <filename>mysql-test/t</filename> directory. Test case filenames
- consist of the test name with a <filename>.test</filename>
+ <filename>mysql-test/t</filename> directory. Test case file
+ names consist of the test name with a <filename>.test</filename>
suffix. For example, a test named <literal>foo</literal> should
be written in the file
<filename>mysql-test/t/foo.test</filename>.
@@ -260,7 +260,7 @@
</programlisting>
<para>
- The filename in the <literal>source</literal> command is
+ The file name in the <literal>source</literal> command is
relative to the <filename>mysql-test</filename> directory.
</para>
@@ -530,8 +530,9 @@
<listitem>
<para>
- Usernames: Usernames should begin with <quote>mysql</quote>
- (for example, <literal>mysqluser1</literal>,
+ User names: User names should begin with
+ <quote>mysql</quote> (for example,
+ <literal>mysqluser1</literal>,
<literal>mysqluser2</literal>)
</para>
</listitem>
@@ -2084,14 +2085,14 @@
<listitem>
<para>
- Performing filesystem operations
+ Performing file system operations
</para>
<para>
Avoid using <literal>exec</literal> or
<literal>system</literal> to execute operating system commands
- for filesystem operations. This used to be very common, but OS
- commands tend to be platform specific, which reduces test
+ for file system operations. This used to be very common, but
+ OS commands tend to be platform specific, which reduces test
portability. <command>mysqltest</command> now has several
commands to perform these operations portably, so these
commands should be used instead:
@@ -2109,11 +2110,11 @@
Some test cases depend on being run on local storage, and may
fail when run on remote storage such as a network share. For
example, if the test result can be affected by differences
- between local and remote filesystem times, the expected result
- might not be obtained. Failure of these test cases under such
- circumstances does not indicate an actual malfunction. It is
- not generally possible to determine whether tests are being
- run on local storage.
+ between local and remote file system times, the expected
+ result might not be obtained. Failure of these test cases
+ under such circumstances does not indicate an actual
+ malfunction. It is not generally possible to determine whether
+ tests are being run on local storage.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r13159 - in trunk: . mysqltest | paul.dubois | 14 Jan |
