Imported MySQL documentation files from ../mysql-5.1.46

1 files changed, 57 insertions, 41 deletions

diff --git a/man/mysqltest.1 b/man/mysqltest.1
index 8bfa3d5da64..a10ac08ed68 100644
--- a/man/mysqltest.1
+++ b/man/mysqltest.1
@@ -2,12 +2,12 @@
 .\"     Title: \fBmysqltest\fR
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 10/29/2009
+.\"      Date: 03/31/2010
 .\"    Manual: MySQL Database System
 .\"    Source: MySQL
 .\"  Language: English
 .\"
-.TH "\FBMYSQLTEST\FR" "1" "10/29/2009" "MySQL" "MySQL Database System"
+.TH "\FBMYSQLTEST\FR" "1" "03/31/2010" "MySQL" "MySQL Database System"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -175,31 +175,11 @@ The base directory for tests\&.
 .sp -1
 .IP \(bu 2.3
 .\}
-.\" mysqltest: big-test option
-.\" big-test option: mysqltest
-\fB\-\-big\-test\fR,
-\fB\-B\fR
-.sp
-Define the
-\fBmysqltest\fR
-variable
-$BIG_TEST
-as 1\&. This option was removed in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.13\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
 .\" mysqltest: character-sets-dir option
 .\" character-sets-dir option: mysqltest
 \fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
 .sp
-The directory where character sets are installed\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.32, and 5\&.1\&.13\&.
+The directory where character sets are installed\&.
 .RE
 .sp
 .RS 4
@@ -226,12 +206,11 @@ Compress all information sent between the client and the server if both support
 .sp -1
 .IP \(bu 2.3
 .\}
-.\" mysqltest: cursor-protocol option
+.\" mysqltest: currsor-protocol option
 .\" cursor-protocol option: mysqltest
 \fB\-\-cursor\-protocol\fR
 .sp
-Use cursors for prepared statements (implies
-\fB\-\-ps\-protocol\fR)\&. This option was added in MySQL 5\&.0\&.19\&.
+Use cursors for prepared statements\&.
 .RE
 .sp
 .RS 4
@@ -281,7 +260,7 @@ value is
 .\" debug-check option: mysqltest
 \fB\-\-debug\-check\fR
 .sp
-Print some debugging information when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
+Print some debugging information when the program exits\&.
 .RE
 .sp
 .RS 4
@@ -296,7 +275,7 @@ Print some debugging information when the program exits\&. This option was added
 .\" debug-info option: mysqltest
 \fB\-\-debug\-info\fR
 .sp
-Print debugging information and memory and CPU usage statistics when the program exits\&. This option was added in MySQL 5\&.1\&.14\&.
+Print debugging information and memory and CPU usage statistics when the program exits\&.
 .RE
 .sp
 .RS 4
@@ -332,7 +311,7 @@ Include the contents of the given file before processing the contents of the tes
 \fBmysqltest\fR
 test files\&. This option has the same effect as putting a
 \-\-source \fIfile_name\fR
-command as the first line of the test file\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.7\&.
+command as the first line of the test file\&.
 .RE
 .sp
 .RS 4
@@ -347,7 +326,7 @@ command as the first line of the test file\&. This option was added in MySQL 4\&
 .\" logdir option: mysqltest
 \fB\-\-logdir=\fR\fB\fIdir_name\fR\fR
 .sp
-The directory to use for log files\&. This option was added in MySQL 5\&.1\&.14\&.
+The directory to use for log files\&.
 .RE
 .sp
 .RS 4
@@ -363,7 +342,7 @@ The directory to use for log files\&. This option was added in MySQL 5\&.1\&.14\
 \fB\-\-mark\-progress\fR
 .sp
 Write the line number and elapsed time to
-\fItest_file\fR\&.progress\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.12\&.
+\fItest_file\fR\&.progress\&.
 .RE
 .sp
 .RS 4
@@ -378,7 +357,24 @@ Write the line number and elapsed time to
 .\" max-connect-retries option: mysqltest
 \fB\-\-max\-connect\-retries=\fR\fB\fInum\fR\fR
 .sp
-The maximum number of connection attempts when connecting to server\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.23, and 5\&.1\&.11\&.
+The maximum number of connection attempts when connecting to server\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mysqltest: max-connections option
+.\" max-connections option: mysqltest
+\fB\-\-max\-connections=\fR\fB\fInum\fR\fR
+.sp
+The maximum number of simultaneous server connections per client (that is, per test)\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&.
+.sp
+This option is available from MySQL 5\&.1\&.45\&.
 .RE
 .sp
 .RS 4
@@ -393,7 +389,7 @@ The maximum number of connection attempts when connecting to server\&. This opti
 .\" no-defaults option: mysqltest
 \fB\-\-no\-defaults\fR
 .sp
-Do not read default options from any option files\&.
+Do not read default options from any option files\&. If used, this must be the first option\&.
 .RE
 .sp
 .RS 4
@@ -484,7 +480,8 @@ Suppress all normal output\&. This is a synonym for
 .sp
 Record the output that results from running the test file into the file named by the
 \fB\-\-result\-file\fR
-option, if that option is given\&.
+option, if that option is given\&. It is an error to use this option without also using
+\fB\-\-result\-file\fR\&.
 .RE
 .sp
 .RS 4
@@ -516,7 +513,9 @@ treats the test actual and expected results for a test case:
 .\}
 If the test produces no results,
 \fBmysqltest\fR
-exits with an error message to that effect\&.
+exits with an error message to that effect, unless
+\fB\-\-result\-file\fR
+is given and the named file is an empty file\&.
 .RE
 .sp
 .RS 4
@@ -551,7 +550,7 @@ reads the expected results from the given file and compares them with the actual
 \fBmysqltest\fR
 writes a
 \&.reject
-file in the same directory as the result file and exits with an error\&.
+file in the same directory as the result file, outputs a diff of the two files, and exits with an error\&.
 .RE
 .sp
 .RS 4
@@ -695,7 +694,22 @@ localhost
 .sp
 Execute DML statements within a stored procedure\&. For every DML statement,
 \fBmysqltest\fR
-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\&.
+creates and invokes a stored procedure that executes the statement rather than executing the statement directly\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mysqltest: tail-lines option
+.\" tail-lines option: mysqltest
+\fB\-\-tail\-lines=\fR\fB\fInn\fR\fR
+.sp
+Specify how many lines of the result to include in the output if the test fails because an SQL statement fails\&. The default is 0, meaning no lines of result printed\&.
 .RE
 .sp
 .RS 4
@@ -727,7 +741,9 @@ Read test input from this file\&. The default is to read from the standard input
 \fB\-\-timer\-file=\fR\fB\fIfile_name\fR\fR,
 \fB\-m \fR\fB\fIfile_name\fR\fR
 .sp
-The file where the timing in microseconds is written\&.
+If given, the number of millisecond spent running the test will be written to this file\&. This is used by
+\fBmysql\-test\-run\&.pl\fR
+for its reporting\&.
 .RE
 .sp
 .RS 4
@@ -743,7 +759,7 @@ The file where the timing in microseconds is written\&.
 \fB\-\-tmpdir=\fR\fB\fIdir_name\fR\fR,
 \fB\-t \fR\fB\fIdir_name\fR\fR
 .sp
-The temporary directory where socket files are put\&.
+The temporary directory where socket files are created\&.
 .RE
 .sp
 .RS 4
@@ -775,7 +791,7 @@ The MySQL user name to use when connecting to the server\&.
 \fB\-\-verbose\fR,
 \fB\-v\fR
 .sp
-Verbose mode\&. Print out more information what the program does\&.
+Verbose mode\&. Print out more information about what the program does\&.
 .RE
 .sp
 .RS 4
@@ -813,7 +829,7 @@ statement is wrapped inside a view\&. This option was added in MySQL 5\&.0\&.19\
 .SH "COPYRIGHT"
 .br
 .PP
-Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
+Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 .PP
 This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
 .PP