Author: plavin
Date: 2007-07-16 23:02:19 +0200 (Mon, 16 Jul 2007)
New Revision: 7120
Log:
Reformat the description so that it is consistent when transferred to a database. Assorted corrections -- easy to spot inconsistencies when you can query a database.
Modified:
trunk/dynamic-docs/command-optvars/mysqld.xml
Modified: trunk/dynamic-docs/command-optvars/mysqld.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysqld.xml 2007-07-16 17:56:59 UTC (rev 7119)
+++ trunk/dynamic-docs/command-optvars/mysqld.xml 2007-07-16 21:02:19 UTC (rev 7120)
Changed blocks: 37, Lines Added: 41, Lines Deleted: 42; 14574 bytes
@@ -418,7 +418,7 @@
<option command="mysqld" section="server" id="Com_do">
<xrefto id="option_mysqld_Com_option_mysqld"/>
<name>Com_do</name>
- <shortdescription lang="en">Count of DO</shortdescription>
+ <shortdescription lang="en">Count of DO statements</shortdescription>
<types>
<vartype isdynamic="no" class="status" scope="both"/>
</types>
@@ -2395,7 +2395,7 @@
<option command="mysqld" section="server" id="Qcache_inserts">
<xrefto id="option_mysqld_Qcache_inserts"/>
<name>Qcache_inserts</name>
- <shortdescription lang="en">The number of query cache hits</shortdescription>
+ <shortdescription lang="en">The number of query cache inserts</shortdescription>
<types>
<vartype isdynamic="no" class="status" scope="both"/>
</types>
@@ -3788,7 +3788,7 @@
<xrefto id="option_mysqld_console"/>
<name>console</name>
- <shortdescription lang="en">Write error output on screen; Don't remove the
+ <shortdescription lang="en">Write error output on screen; do not remove the
console window on windows</shortdescription>
<platforms applies="windows"/>
<types>
@@ -4168,7 +4168,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="des-key-file">
+ <option command="mysqld" section="security" id="des-key-file">
<xrefto id="option_mysqld_des-key-file"/>
<name>des-key-file</name>
<shortdescription lang="en">Load keys for des_encrypt() and des_encrypt from
@@ -4311,7 +4311,7 @@
<name>event-scheduler</name>
<shortdescription lang="en">Enable/disable and start/stop the event
scheduler. Note that this variable underwent significant changes in
- behaviour and permitted values in MySQL 5.1.11 and 5.1.12</shortdescription>
+ behavior and permitted values in MySQL 5.1.11 and 5.1.12</shortdescription>
<types>
<optype class="cmdline" format="--event-scheduler=#"
setvar="event_scheduler" inversion="5.1.6"/>
@@ -4788,7 +4788,7 @@
<xrefto id="option_mysqld_innodb_additional_mem_pool_size"/>
<name>innodb_additional_mem_pool_size</name>
<shortdescription lang="en">Size of a memory pool InnoDB uses to store data
- dictionary information and other internal data structures</shortdescription>
+ dictionary information and other internal data structures</shortdescription>
<types>
<optype class="cmdline" format="--innodb_additional_mem_pool_size=#"
setvar="innodb_additional_mem_pool_size"/>
@@ -4909,7 +4909,7 @@
<xrefto id="option_mysqld_innodb_buffer_pool_size"/>
<name>innodb_buffer_pool_size</name>
<shortdescription lang="en">The size of the memory buffer InnoDB uses to
- cache data and indexes of its tables</shortdescription>
+ cache data and indexes of its tables</shortdescription>
<platforms applies="windows"/>
<types>
<optype class="cmdline" format="--innodb_buffer_pool_size=#"
@@ -4992,9 +4992,9 @@
<option command="mysqld" section="innodb" id="innodb-safe-binlog">
<xrefto id="option_mysqld_innodb-safe-binlog"/>
<name>innodb-safe-binlog</name>
- <shortdescription lang="en">Adds consistency guarantees between
+ <shortdescription lang="en">Adds consistency guarantees between
the content of InnoDB tables and the binary log
- </shortdescription>
+ </shortdescription>
<deprecated version="5.0.3"/>
<types>
<optype class="cmdline" format="--innodb-safe-binlog"
@@ -5011,7 +5011,7 @@
<xrefto id="option_mysqld_innodb_commit_concurrency"/>
<name>innodb_commit_concurrency</name>
<shortdescription lang="en">Helps in performance tuning in heavily
- concurrent environments</shortdescription>
+ concurrent environments</shortdescription>
<types>
<optype class="cmdline" format="--innodb_commit_concurrency=#"
@@ -5195,7 +5195,7 @@
<xrefto id="option_mysqld_innodb_fast_shutdown"/>
<name>innodb_fast_shutdown</name>
<shortdescription lang="en">Speeds up the shutdown process of the InnoDB
- storage engine</shortdescription>
+ storage engine</shortdescription>
<types>
<optype class="cmdline" format="--innodb_fast_shutdown[=#]"
setvar="innodb_fast_shutdown"/>
@@ -5241,8 +5241,7 @@
<option command="mysqld" section="innodb" id="innodb_file_io_threads">
<xrefto id="option_mysqld_innodb_file_io_threads"/>
<name>innodb_file_io_threads</name>
- <shortdescription lang="en">Number of file I/O threads in InnoDB
- </shortdescription>
+ <shortdescription lang="en">Number of file I/O threads in InnoDB</shortdescription>
<types>
<optype class="cmdline" format="--innodb_file_io_threads=#"
setvar="innodb_file_io_threads"/>
@@ -5282,7 +5281,7 @@
<xrefto id="option_mysqld_innodb_file_per_table"/>
<name>innodb_file_per_table</name>
<shortdescription lang="en">Stores each InnoDB table to an .ibd file in the
- database dir</shortdescription>
+ database dir</shortdescription>
<types>
<optype class="cmdline" format="--innodb_file_per_table"
setvar="innodb_file_per_table"/>
@@ -5442,7 +5441,7 @@
<xrefto id="option_mysqld_innodb_force_recovery"/>
<name>innodb_force_recovery</name>
<shortdescription lang="en">Helps to save your data in case the disk image
- of the database becomes corrupt</shortdescription>
+ of the database becomes corrupt</shortdescription>
<types>
<optype class="cmdline" format="--innodb_force_recovery=#"
setvar="innodb_force_recovery"/>
@@ -5538,7 +5537,7 @@
<xrefto id="option_mysqld_innodb_locks_unsafe_for_binlog"/>
<name>innodb_locks_unsafe_for_binlog</name>
<shortdescription lang="en">Force InnoDB not to use next-key locking.
- Instead use only row-level locking</shortdescription>
+ Instead use only row-level locking</shortdescription>
<types>
<optype class="cmdline" format="--innodb_locks_unsafe_for_binlog"
setvar="innodb_locks_unsafe_for_binlog"/>
@@ -5597,8 +5596,7 @@
<option command="mysqld" section="innodb" id="innodb_log_archive">
<xrefto id="option_mysqld_innodb_log_archive"/>
<name>innodb_log_archive</name>
- <shortdescription lang="en">Set to 1 if you want to have logs archived
- </shortdescription>
+ <shortdescription lang="en">Set to 1 if you want to have logs archived</shortdescription>
<types>
<optype class="cmdline" format="--innodb_log_archive[=#]"/>
@@ -6047,7 +6045,7 @@
<xrefto id="option_mysqld_innodb_status_file"/>
<name>innodb_status_file</name>
<shortdescription lang="en">Enable SHOW INNODB STATUS output in the
- innodb_status.[pid] file</shortdescription>
+ innodb_status.[pid] file</shortdescription>
<types>
<optype class="cmdline" format="--innodb_status_file"
setvar="innodb_status_file"/>
@@ -6343,7 +6341,7 @@
<name>isam</name>
<shortdescription lang="en">Obsolete. ISAM storage engine is no longer
- supported</shortdescription>
+ supported</shortdescription>
<deprecated/>
<types>
<optype class="cmdline" format="--isam" setvar="isam"/>
@@ -7081,7 +7079,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="master-password">
+ <option command="mysqld" section="replication" id="master-password">
<xrefto id="replication-options"/>
<name>master-password</name>
@@ -7292,7 +7290,7 @@
<manual version="5.1"/>
</versions>
</option>
- <option command="mysqld" section="server" id="max-binlog-dump-events">
+ <option command="mysqld" section="binlog" id="max-binlog-dump-events">
<xrefto id="option_mysqld_max-binlog-dump-events"/>
<name>max-binlog-dump-events</name>
<shortdescription lang="en">Option used by mysql-test for debugging and
@@ -7333,7 +7331,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="max_binlog_cache_size">
+ <option command="mysqld" section="binlog" id="max_binlog_cache_size">
<xrefto id="option_mysqld_max_binlog_cache_size"/>
<name>max_binlog_cache_size</name>
@@ -7355,7 +7353,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="max_binlog_size">
+ <option command="mysqld" section="binlog" id="max_binlog_size">
<xrefto id="option_mysqld_max_binlog_size"/>
<name>max_binlog_size</name>
@@ -8154,7 +8152,7 @@
<xrefto id="option_mysqld_ndb_force_send"/>
<name>ndb_force_send</name>
- <shortdescription lang="en">same as --ndb-force-send</shortdescription>
+ <shortdescription lang="en">Same as --ndb-force-send</shortdescription>
<types>
<optype class="cmdline" format="--ndb-force-send" setvar="ndb_force_send"/>
<optype class="mycnf"/>
@@ -8392,7 +8390,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="old-passwords">
+ <option command="mysqld" section="security" id="old-passwords">
<xrefto id="option_mysqld_old-passwords"/>
<name>old-passwords</name>
<shortdescription lang="en">Use old password encryption method (needed for
@@ -9034,7 +9032,7 @@
<xrefto id="replication-options"/>
<name>replicate-ignore-db</name>
- <shortdescription lang="en">Tells the slave thread to not replicate to the
+ <shortdescription lang="en">Tells the slave thread not to replicate to the
specified database</shortdescription>
<seealso xref="replicate-do-db"/>
<types>
@@ -9053,7 +9051,7 @@
<xrefto id="replication-options"/>
<name>replicate-ignore-table</name>
- <shortdescription lang="en">Tells the slave thread to not replicate to the
+ <shortdescription lang="en">Tells the slave thread not to replicate to the
specified table</shortdescription>
<seealso xref="replicate-do-table"/>
<types>
@@ -9068,7 +9066,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="replicate-rewrite-db">
+ <option command="mysqld" section="replication" id="replicate-rewrite-db">
<xrefto id="replication-options"/>
<name>replicate-rewrite-db</name>
@@ -9086,7 +9084,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="replicate-same-server-id">
+ <option command="mysqld" section="replication" id="replicate-same-server-id">
<xrefto id="replication-options"/>
<name>replicate-same-server-id</name>
@@ -9303,7 +9301,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="secure-auth">
+ <option command="mysqld" section="security" id="secure-auth">
<xrefto id="option_mysqld_secure-auth"/>
<name>secure-auth</name>
@@ -9325,7 +9323,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="secure-file-priv">
+ <option command="mysqld" section="security" id="secure-file-priv">
<xrefto id="option_mysqld_secure-file-priv"/>
<name>secure-file-priv</name>
@@ -10025,7 +10023,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="sporadic-binlog-dump-fail">
+ <option command="mysqld" section="binlog" id="sporadic-binlog-dump-fail">
<xrefto id="option_mysqld_sporadic-binlog-dump-fail"/>
<name>sporadic-binlog-dump-fail</name>
<shortdescription lang="en">Option used by mysql-test for debugging and
@@ -10537,7 +10535,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="sync-bdb-logs">
+ <option command="mysqld" section="bdb" id="sync-bdb-logs">
<xrefto id="option_mysqld_sync-bdb-logs"/>
<name>sync-bdb-logs</name>
<shortdescription lang="en">Synchronously flush Berkeley DB logs. Enabled by
@@ -10854,7 +10852,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="timed_mutexes">
+ <option command="mysqld" section="innodb" id="timed_mutexes">
<xrefto id="option_mysqld_timed_mutexes"/>
<name>timed_mutexes</name>
@@ -11020,7 +11018,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="unique_checks">
+ <option command="mysqld" section="innodb" id="unique_checks">
<name>unique_checks</name>
<shortdescription lang="en">If set to 1 (the default), uniqueness checks
for secondary indexes in InnoDB tables are performed</shortdescription>
@@ -11594,7 +11592,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="have_innodb">
+ <option command="mysqld" section="innodb" id="have_innodb">
<!-- what is this in 5.1.8 -->
<xrefto id="option_mysqld_have_innodb"/>
<name>have_innodb</name>
@@ -11610,7 +11608,7 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="have_ndbcluster">
+ <option command="mysqld" section="ndb" id="have_ndbcluster">
<xrefto id="option_mysqld_have_ndbcluster"/>
<name>have_ndb_cluster</name>
<shortdescription lang="en">Does mysqld supports NDB Cluster tables</shortdescription>
@@ -11643,7 +11641,7 @@
</option>
<option command="mysqld" section="server" id="have_query_cache">
<xrefto id="option_mysqld_have_query_cache"/>
- <name>have_openssl</name>
+ <name>have_query_cache</name>
<shortdescription lang="en">Does mysqld support query cache</shortdescription>
<types>
<vartype isdynamic="no" class="status" scope="both"/>
@@ -11656,10 +11654,11 @@
<manual version="5.2"/>
</versions>
</option>
- <option command="mysqld" section="server" id="have_rtree_keys">
+ <option command="mysqld" section="myisam" id="have_rtree_keys">
<xrefto id="option_mysqld_have_rtree_keys"/>
- <name>have_openssl</name>
- <shortdescription lang="en">Does mysqld support query cache</shortdescription>
+ <name>have_rtree_keys</name>
+ <shortdescription lang="en">YES if RTREE indexes are available, NO if not.
+ (These are used for spatial indexes in MyISAM tables.)</shortdescription>
<types>
<vartype isdynamic="no" class="status" scope="both"/>
</types>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7120 - trunk/dynamic-docs/command-optvars | plavin | 16 Jul |
