Author: paul
Date: 2007-10-08 17:34:06 +0200 (Mon, 08 Oct 2007)
New Revision: 8025
Log:
r30797@arctic: paul | 2007-10-08 10:29:15 -0500
Kill some todos.
Make some corrections/clarifications.
Modified:
trunk/refman-4.1/using-mysql-programs.xml
trunk/refman-5.0/using-mysql-programs.xml
trunk/refman-5.1/using-mysql-programs.xml
trunk/refman-5.2/using-mysql-programs.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:30756
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:25385
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:20005
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:30797
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:25385
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:20005
Modified: trunk/refman-4.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-4.1/using-mysql-programs.xml 2007-10-08 14:32:33 UTC (rev 8024)
+++ trunk/refman-4.1/using-mysql-programs.xml 2007-10-08 15:34:06 UTC (rev 8025)
Changed blocks: 9, Lines Added: 37, Lines Deleted: 21; 4664 bytes
@@ -60,6 +60,11 @@
<title>Overview of MySQL Programs</title>
+ <remark role="todo">
+ When the programs chapter gets merged with this one, make sure
+ that this list includes all programs described here.
+ </remark>
+
<para>
MySQL AB provides several types of programs:
</para>
@@ -108,10 +113,6 @@
Client programs that access the server:
</para>
- <remark role="todo">
- this table is missing some programs (e.g., replace).
- </remark>
-
<itemizedlist>
<listitem>
@@ -252,10 +253,10 @@
<para>
Arguments that begin with a single or double dash
(<quote><literal>-</literal></quote>,
- <quote><literal>--</literal></quote>) are option arguments.
Options
- typically specify the type of connection a program should make to
- the server or affect its operational mode. Option syntax is
- described in <xref linkend="program-options"/>.
+ <quote><literal>--</literal></quote>) are option arguments.
+ Options typically specify the type of connection a program should
+ make to the server or affect its operational mode. Option syntax
+ is described in <xref linkend="program-options"/>.
</para>
<para>
@@ -382,9 +383,9 @@
<listitem>
<para>
- List the options in environment variables (see xref
- linkend="setting-environment-variables"/>). This method is
- useful for options that you want to apply each time the
+ List the options in environment variables (see
+ <xref linkend="setting-environment-variables"/>). This method
+ is useful for options that you want to apply each time the
program runs. In practice, option files are used more commonly
for this purpose. However,
<xref linkend="multiple-unix-servers"/>, discusses one
@@ -431,7 +432,7 @@
unambiguous prefix. For example, the <option>--compress</option>
option can be given to <command>mysqldump</command> as
<option>--compr</option>, but not as
<option>--comp</option>
- because that is ambiguous:
+ because the latter is ambiguous:
</para>
<programlisting>
@@ -555,11 +556,6 @@
discusses that topic further.
</para>
- <remark role="todo">
- Also: can specify unambigious prefix of option - hm, but that's
- not 4.0.2 (?), so it should be mentioned earlier.
- </remark>
-
<para>
Some options control behavior that can be turned on or off. For
example, the <command>mysql</command> client supports a
@@ -980,9 +976,9 @@
<para>
Comment lines start with
<quote><literal>#</literal></quote>
- or <quote><literal>;</literal></quote>. As of MySQL
4.0.14, a
- <quote><literal>#</literal></quote> comment can start
in the
- middle of a line as well.
+ or <quote><literal>;</literal></quote>. As of MySQL
4.0.14,
+ a <quote><literal>#</literal></quote> comment can
start in
+ the middle of a line as well.
</para>
</listitem>
@@ -1500,6 +1496,26 @@
</programlisting>
<para>
+ A variable can be specified by writing it in full or as any
+ unambiguous prefix. For example, the
+ <literal>max_buffer_length</literal> variable can be set for
+ <command>mysql</command> as <option>--max_a</option>, but
not as
+ <option>--max</option> because the latter is ambiguous:
+ </para>
+
+<programlisting>
+shell> <userinput>mysql --max=1000000</userinput>
+mysql: ambiguous option '--max=1000000' (max_allowed_packet, max_join_size)
+</programlisting>
+
+ <para>
+ Be aware that the use of variable prefixes can cause problems in
+ the event that new variables are implemented for a program. A
+ prefix that is unambigious now might become ambiguous in the
+ future.
+ </para>
+
+ <para>
Prior to MySQL 4.0.2, program variable names are not recognized
as option names. Instead, use the
<option>--set-variable</option> option to assign a value to a
@@ -1532,7 +1548,7 @@
<para>
With <option>--set-variable</option>, underscores in variable
names cannot be given as dashes for versions of MySQL older than
- 4.0.2.
+ 4.0.2, and the variable name must be specified in full.
</para>
<para>
Modified: trunk/refman-5.0/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.0/using-mysql-programs.xml 2007-10-08 14:32:33 UTC (rev 8024)
+++ trunk/refman-5.0/using-mysql-programs.xml 2007-10-08 15:34:06 UTC (rev 8025)
Changed blocks: 8, Lines Added: 36, Lines Deleted: 19; 4332 bytes
@@ -60,6 +60,11 @@
<title>Overview of MySQL Programs</title>
+ <remark role="todo">
+ When the programs chapter gets merged with this one, make sure
+ that this list includes all programs described here.
+ </remark>
+
<para>
MySQL AB provides several types of programs:
</para>
@@ -115,10 +120,6 @@
Client programs that access the server:
</para>
- <remark role="todo">
- this table is missing some programs (e.g., replace).
- </remark>
-
<itemizedlist>
<listitem>
@@ -259,10 +260,10 @@
<para>
Arguments that begin with a single or double dash
(<quote><literal>-</literal></quote>,
- <quote><literal>--</literal></quote>) are option arguments.
Options
- typically specify the type of connection a program should make to
- the server or affect its operational mode. Option syntax is
- described in <xref linkend="program-options"/>.
+ <quote><literal>--</literal></quote>) are option arguments.
+ Options typically specify the type of connection a program should
+ make to the server or affect its operational mode. Option syntax
+ is described in <xref linkend="program-options"/>.
</para>
<para>
@@ -389,9 +390,9 @@
<listitem>
<para>
- List the options in environment variables (see xref
- linkend="setting-environment-variables"/>). This method is
- useful for options that you want to apply each time the
+ List the options in environment variables (see
+ <xref linkend="setting-environment-variables"/>). This method
+ is useful for options that you want to apply each time the
program runs. In practice, option files are used more commonly
for this purpose. However,
<xref linkend="multiple-unix-servers"/>, discusses one
@@ -438,7 +439,7 @@
unambiguous prefix. For example, the <option>--compress</option>
option can be given to <command>mysqldump</command> as
<option>--compr</option>, but not as
<option>--comp</option>
- because that is ambiguous:
+ because the latter is ambiguous:
</para>
<programlisting>
@@ -550,11 +551,6 @@
</itemizedlist>
- <remark role="todo">
- Also: can specify unambigious prefix of option - hm, but that's
- not 4.0.2 (?), so it should be mentioned earlier.
- </remark>
-
<para>
Some options control behavior that can be turned on or off. For
example, the <command>mysql</command> client supports a
@@ -1516,6 +1512,26 @@
key-buffer-size=512M
</programlisting>
+ <para>
+ A variable can be specified by writing it in full or as any
+ unambiguous prefix. For example, the
+ <literal>max_buffer_length</literal> variable can be set for
+ <command>mysql</command> as <option>--max_a</option>, but
not as
+ <option>--max</option> because the latter is ambiguous:
+ </para>
+
+<programlisting>
+shell> <userinput>mysql --max=1000000</userinput>
+mysql: ambiguous option '--max=1000000' (max_allowed_packet, max_join_size)
+</programlisting>
+
+ <para>
+ Be aware that the use of variable prefixes can cause problems in
+ the event that new variables are implemented for a program. A
+ prefix that is unambigious now might become ambiguous in the
+ future.
+ </para>
+
<note>
<para>
Before MySQL 4.0.2, the only syntax for setting program
@@ -1523,8 +1539,9 @@
<option>--set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
(or
<option>set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
- in option files). This syntax still is recognized, but is
- deprecated as of MySQL 4.0.2.
+ in option files). Underscores cannot be given as dashes, and
+ the variable name must be specified in full. This syntax still
+ is recognized, but is now deprecated.
</para>
</note>
Modified: trunk/refman-5.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.1/using-mysql-programs.xml 2007-10-08 14:32:33 UTC (rev 8024)
+++ trunk/refman-5.1/using-mysql-programs.xml 2007-10-08 15:34:06 UTC (rev 8025)
Changed blocks: 8, Lines Added: 36, Lines Deleted: 19; 4332 bytes
@@ -60,6 +60,11 @@
<title>Overview of MySQL Programs</title>
+ <remark role="todo">
+ When the programs chapter gets merged with this one, make sure
+ that this list includes all programs described here.
+ </remark>
+
<para>
MySQL AB provides several types of programs:
</para>
@@ -115,10 +120,6 @@
Client programs that access the server:
</para>
- <remark role="todo">
- this table is missing some programs (e.g., replace).
- </remark>
-
<itemizedlist>
<listitem>
@@ -259,10 +260,10 @@
<para>
Arguments that begin with a single or double dash
(<quote><literal>-</literal></quote>,
- <quote><literal>--</literal></quote>) are option arguments.
Options
- typically specify the type of connection a program should make to
- the server or affect its operational mode. Option syntax is
- described in <xref linkend="program-options"/>.
+ <quote><literal>--</literal></quote>) are option arguments.
+ Options typically specify the type of connection a program should
+ make to the server or affect its operational mode. Option syntax
+ is described in <xref linkend="program-options"/>.
</para>
<para>
@@ -389,9 +390,9 @@
<listitem>
<para>
- List the options in environment variables (see xref
- linkend="setting-environment-variables"/>). This method is
- useful for options that you want to apply each time the
+ List the options in environment variables (see
+ <xref linkend="setting-environment-variables"/>). This method
+ is useful for options that you want to apply each time the
program runs. In practice, option files are used more commonly
for this purpose. However,
<xref linkend="multiple-unix-servers"/>, discusses one
@@ -438,7 +439,7 @@
unambiguous prefix. For example, the <option>--compress</option>
option can be given to <command>mysqldump</command> as
<option>--compr</option>, but not as
<option>--comp</option>
- because that is ambiguous:
+ because the latter is ambiguous:
</para>
<programlisting>
@@ -550,11 +551,6 @@
</itemizedlist>
- <remark role="todo">
- Also: can specify unambigious prefix of option - hm, but that's
- not 4.0.2 (?), so it should be mentioned earlier.
- </remark>
-
<para>
Some options control behavior that can be turned on or off. For
example, the <command>mysql</command> client supports a
@@ -1516,6 +1512,26 @@
key-buffer-size=512M
</programlisting>
+ <para>
+ A variable can be specified by writing it in full or as any
+ unambiguous prefix. For example, the
+ <literal>max_buffer_length</literal> variable can be set for
+ <command>mysql</command> as <option>--max_a</option>, but
not as
+ <option>--max</option> because the latter is ambiguous:
+ </para>
+
+<programlisting>
+shell> <userinput>mysql --max=1000000</userinput>
+mysql: ambiguous option '--max=1000000' (max_allowed_packet, max_join_size)
+</programlisting>
+
+ <para>
+ Be aware that the use of variable prefixes can cause problems in
+ the event that new variables are implemented for a program. A
+ prefix that is unambigious now might become ambiguous in the
+ future.
+ </para>
+
<note>
<para>
Before MySQL 4.0.2, the only syntax for setting program
@@ -1523,8 +1539,9 @@
<option>--set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
(or
<option>set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
- in option files). This syntax still is recognized, but is
- deprecated as of MySQL 4.0.2.
+ in option files). Underscores cannot be given as dashes, and
+ the variable name must be specified in full. This syntax still
+ is recognized, but is now deprecated.
</para>
</note>
Modified: trunk/refman-5.2/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.2/using-mysql-programs.xml 2007-10-08 14:32:33 UTC (rev 8024)
+++ trunk/refman-5.2/using-mysql-programs.xml 2007-10-08 15:34:06 UTC (rev 8025)
Changed blocks: 8, Lines Added: 36, Lines Deleted: 19; 4332 bytes
@@ -60,6 +60,11 @@
<title>Overview of MySQL Programs</title>
+ <remark role="todo">
+ When the programs chapter gets merged with this one, make sure
+ that this list includes all programs described here.
+ </remark>
+
<para>
MySQL AB provides several types of programs:
</para>
@@ -115,10 +120,6 @@
Client programs that access the server:
</para>
- <remark role="todo">
- this table is missing some programs (e.g., replace).
- </remark>
-
<itemizedlist>
<listitem>
@@ -259,10 +260,10 @@
<para>
Arguments that begin with a single or double dash
(<quote><literal>-</literal></quote>,
- <quote><literal>--</literal></quote>) are option arguments.
Options
- typically specify the type of connection a program should make to
- the server or affect its operational mode. Option syntax is
- described in <xref linkend="program-options"/>.
+ <quote><literal>--</literal></quote>) are option arguments.
+ Options typically specify the type of connection a program should
+ make to the server or affect its operational mode. Option syntax
+ is described in <xref linkend="program-options"/>.
</para>
<para>
@@ -389,9 +390,9 @@
<listitem>
<para>
- List the options in environment variables (see xref
- linkend="setting-environment-variables"/>). This method is
- useful for options that you want to apply each time the
+ List the options in environment variables (see
+ <xref linkend="setting-environment-variables"/>). This method
+ is useful for options that you want to apply each time the
program runs. In practice, option files are used more commonly
for this purpose. However,
<xref linkend="multiple-unix-servers"/>, discusses one
@@ -438,7 +439,7 @@
unambiguous prefix. For example, the <option>--compress</option>
option can be given to <command>mysqldump</command> as
<option>--compr</option>, but not as
<option>--comp</option>
- because that is ambiguous:
+ because the latter is ambiguous:
</para>
<programlisting>
@@ -550,11 +551,6 @@
</itemizedlist>
- <remark role="todo">
- Also: can specify unambigious prefix of option - hm, but that's
- not 4.0.2 (?), so it should be mentioned earlier.
- </remark>
-
<para>
Some options control behavior that can be turned on or off. For
example, the <command>mysql</command> client supports a
@@ -1516,6 +1512,26 @@
key-buffer-size=512M
</programlisting>
+ <para>
+ A variable can be specified by writing it in full or as any
+ unambiguous prefix. For example, the
+ <literal>max_buffer_length</literal> variable can be set for
+ <command>mysql</command> as <option>--max_a</option>, but
not as
+ <option>--max</option> because the latter is ambiguous:
+ </para>
+
+<programlisting>
+shell> <userinput>mysql --max=1000000</userinput>
+mysql: ambiguous option '--max=1000000' (max_allowed_packet, max_join_size)
+</programlisting>
+
+ <para>
+ Be aware that the use of variable prefixes can cause problems in
+ the event that new variables are implemented for a program. A
+ prefix that is unambigious now might become ambiguous in the
+ future.
+ </para>
+
<note>
<para>
Before MySQL 4.0.2, the only syntax for setting program
@@ -1523,8 +1539,9 @@
<option>--set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
(or
<option>set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
- in option files). This syntax still is recognized, but is
- deprecated as of MySQL 4.0.2.
+ in option files). Underscores cannot be given as dashes, and
+ the variable name must be specified in full. This syntax still
+ is recognized, but is now deprecated.
</para>
</note>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8025 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-5.2 | paul | 8 Oct |