ctdb-docs: Move some configuration options out of the debug section

These aren't test options so improve their visibility.

Signed-off-by: Martin Schwenke <martin@meltin.net>
Reviewed-by: Amitay Isaacs <amitay@gmail.com>

diff --git a/ctdb/doc/ctdbd.conf.5.xml b/ctdb/doc/ctdbd.conf.5.xml
index f0f903b81c0cf78032433fb261a80968ead6f878..8aa132ba9ee9e008284b170a140702e64aef1271 100644 (file)
--- a/ctdb/doc/ctdbd.conf.5.xml
+++ b/ctdb/doc/ctdbd.conf.5.xml
@@ -183,6 +183,50 @@
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>CTDB_DEBUG_HUNG_SCRIPT=<parameter>FILENAME</parameter></term>
+       <listitem>
+         <para>
+           FILENAME is a script to run to log debug information when
+           an event script times out.
+         </para>
+         <para>
+           Default is <filename>/usr/local/etc/ctdb/debug-hung-script.sh</filename>.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>CTDB_DEBUG_HUNG_SCRIPT_STACKPAT=<parameter>REGEXP</parameter></term>
+       <listitem>
+         <para>
+           REGEXP specifies interesting processes for which stack
+           traces should be logged when debugging hung eventscripts
+           and those processes are matched in pstree output.  REGEXP
+           is an extended regexp so choices are separated by pipes
+           ('|').  However, REGEXP should not contain parentheses.
+           See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
+         </para>
+         <para>
+           Default is "exportfs|rpcinfo".
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>CTDB_DEBUG_LOCKS=<parameter>FILENAME</parameter></term>
+       <listitem>
+         <para>
+           FILENAME is a script to run to log debug information when
+           an CTDB fails to freeze databases during recovery.
+         </para>
+         <para>
+           No default, usually
+           <filename>/usr/local/etc/ctdb/debug_locks.sh</filename>.
+         </para>
+       </listitem>
+      </varlistentry>
+
       <varlistentry>
        <term>CTDB_DEBUGLEVEL=<parameter>DEBUGLEVEL</parameter></term>
        <listitem>
@@ -275,6 +319,18 @@
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>CTDB_MAX_OPEN_FILES=<parameter>NUM</parameter></term>
+       <listitem>
+         <para>
+           NUM is the maximum number of open files.
+         </para>
+         <para>
+           There is no default.
+         </para>
+       </listitem>
+      </varlistentry>
+
       <varlistentry>
        <term>CTDB_NOSETSCHED=yes|no</term>
        <listitem>
@@ -387,6 +443,18 @@
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>CTDB_SUPPRESS_COREFILE=yes|no</term>
+       <listitem>
+         <para>
+           Whether CTDB core files should be suppressed.
+         </para>
+         <para>
+           Default is no.
+         </para>
+       </listitem>
+      </varlistentry>
+
       <varlistentry>
        <term>CTDB_TRANSPORT=tcp|infiniband</term>
        <listitem>
@@ -1302,6 +1370,45 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
       </variablelist>
     </refsect2>
 
+    <refsect2>
+      <title>
+       DATABASE SETUP
+      </title>
+
+      <para>
+       CTDB checks the consistency of databases during startup.
+      </para>
+
+      <refsect3>
+       <title>Eventscripts</title>
+
+       <simplelist>
+         <member><filename>00.ctdb</filename></member>
+       </simplelist>
+
+      </refsect3>
+
+      <variablelist>
+
+       <varlistentry>
+         <term>CTDB_MAX_CORRUPT_DB_BACKUPS=<parameter>NUM</parameter></term>
+         <listitem>
+           <para>
+             NUM is the maximum number of volatile TDB database backups
+             to be kept (for each database) when a corrupt database is
+             found during startup.  Volatile TDBs are zeroed during
+             startup so backups are needed to debug any corruption that
+             occurs before a restart.
+           </para>
+           <para>
+             Default is 10.
+           </para>
+         </listitem>
+       </varlistentry>
+
+      </variablelist>
+    </refsect2>
+
     <refsect2>
       <title>
        SYSTEM RESOURCE MONITORING CONFIGURATION
@@ -1405,29 +1512,16 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
 
   <refsect1>
     <title>
-      DEBUG AND TEST
+      TEST OPTIONS
     </title>
 
     <para>
-      Variable in this section are for debugging and testing CTDB.
-      They should not generally be needed.
+      Variable in this section are for testing CTDB.  They should not
+      generally be needed.
     </para>
 
     <variablelist>
 
-      <varlistentry>
-       <term>CTDB_DEBUG_HUNG_SCRIPT=<parameter>FILENAME</parameter></term>
-       <listitem>
-         <para>
-           FILENAME is a script to run to log debug information when
-           an event script times out.
-         </para>
-         <para>
-           Default is <filename>/usr/local/etc/ctdb/debug-hung-script.sh</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>CTDB_DEBUG_HUNG_SCRIPT_LOGFILE=<parameter>FILENAME</parameter></term>
        <listitem>
@@ -1443,37 +1537,6 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
        </listitem>
       </varlistentry>
 
-      <varlistentry>
-       <term>CTDB_DEBUG_HUNG_SCRIPT_STACKPAT=<parameter>REGEXP</parameter></term>
-       <listitem>
-         <para>
-           REGEXP specifies interesting processes for which stack
-           traces should be logged when debugging hung eventscripts
-           and those processes are matched in pstree output.  REGEXP
-           is an extended regexp so choices are separated by pipes
-           ('|').  However, REGEXP should not contain parentheses.
-           See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
-         </para>
-         <para>
-           Default is "exportfs|rpcinfo".
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>CTDB_DEBUG_LOCKS=<parameter>FILENAME</parameter></term>
-       <listitem>
-         <para>
-           FILENAME is a script to run to log debug information when
-           an CTDB fails to freeze databases during recovery.
-         </para>
-         <para>
-           No default, usually
-           <filename>/usr/local/etc/ctdb/debug_locks.sh</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>CTDB_SYS_ETCDIR=<parameter>DIRECTORY</parameter></term>
        <listitem>
@@ -1488,34 +1551,6 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
        </listitem>
       </varlistentry>
 
-      <varlistentry>
-       <term>CTDB_MAX_CORRUPT_DB_BACKUPS=<parameter>NUM</parameter></term>
-       <listitem>
-         <para>
-           NUM is the maximum number of volatile TDB database backups
-           to be kept (for each database) when a corrupt database is
-           found during startup.  Volatile TDBs are zeroed during
-           startup so backups are needed to debug any corruption that
-           occurs before a restart.
-         </para>
-         <para>
-           Default is 10.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>CTDB_MAX_OPEN_FILES=<parameter>NUM</parameter></term>
-       <listitem>
-         <para>
-           NUM is the maximum number of open files.
-         </para>
-         <para>
-           There is no default.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>CTDB_RUN_TIMEOUT_MONITOR=yes|no</term>
        <listitem>
@@ -1529,18 +1564,6 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
        </listitem>
       </varlistentry>
 
-      <varlistentry>
-       <term>CTDB_SUPPRESS_COREFILE=yes|no</term>
-       <listitem>
-         <para>
-           Whether CTDB core files should be suppressed.
-         </para>
-         <para>
-           Default is no.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>CTDB_VALGRIND=yes|no|<parameter>COMMAND</parameter></term>
        <listitem>