ctdb-docs: Move remaining test options to README
authorMartin Schwenke <martin@meltin.net>
Thu, 5 Apr 2018 06:12:31 +0000 (16:12 +1000)
committerMartin Schwenke <martins@samba.org>
Tue, 1 May 2018 11:31:19 +0000 (13:31 +0200)
Test options do not belong in the user documentation.  Move them to
the README file in the tests/ subdirectory.

Signed-off-by: Martin Schwenke <martin@meltin.net>
Reviewed-by: Amitay Isaacs <amitay@gmail.com>
ctdb/doc/ctdbd.conf.5.xml
ctdb/tests/README

index 13bcc3c..d0b25c1 100644 (file)
@@ -1499,78 +1499,6 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
 
   </refsect1>
 
-  <refsect1>
-    <title>
-      TEST OPTIONS
-    </title>
-
-    <para>
-      Variable in this section are for testing CTDB.  They should not
-      generally be needed.
-    </para>
-
-    <variablelist>
-
-      <varlistentry>
-       <term>CTDB_DEBUG_HUNG_SCRIPT_LOGFILE=<parameter>FILENAME</parameter></term>
-       <listitem>
-         <para>
-           FILENAME specifies where log messages should go when
-           debugging hung eventscripts.  This is a testing option.
-           See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
-         </para>
-         <para>
-           No default.  Messages go to stdout/stderr and are logged
-           to the same place as other CTDB log messages.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>CTDB_SYS_ETCDIR=<parameter>DIRECTORY</parameter></term>
-       <listitem>
-         <para>
-           DIRECTORY containing system configuration files.  This is
-           used to provide alternate configuration when testing and
-           should not need to be changed from the default.
-         </para>
-         <para>
-           Default is <filename>/etc</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>CTDB_RUN_TIMEOUT_MONITOR=yes|no</term>
-       <listitem>
-         <para>
-           Whether CTDB should simulate timing out monitor events.
-           This uses the <filename>99.timeout</filename> eventscript.
-         </para>
-         <para>
-           Default is no.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>CTDB_VARDIR=<parameter>DIRECTORY</parameter></term>
-       <listitem>
-         <para>
-           DIRECTORY containing CTDB files that are modified at
-           runtime.
-         </para>
-         <para>
-           Defaults to <filename>/usr/local/var/lib/ctdb</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </refsect1>
-
-
   <refsect1>
     <title>FILES</title>
 
index c9eec4d..1cbd765 100644 (file)
@@ -137,3 +137,29 @@ Test and debugging variable options
             expense of some consistency checking
 
           * Disables real-time scheduling
+
+       CTDB_DEBUG_HUNG_SCRIPT_LOGFILE=FILENAME
+          FILENAME specifies where log messages should go when
+          debugging hung eventscripts. This is a testing option. See
+          also CTDB_DEBUG_HUNG_SCRIPT.
+
+          No default. Messages go to stdout/stderr and are logged to
+          the same place as other CTDB log messages.
+
+       CTDB_SYS_ETCDIR=DIRECTORY
+          DIRECTORY containing system configuration files. This is
+          used to provide alternate configuration when testing and
+          should not need to be changed from the default.
+
+          Default is /etc.
+
+       CTDB_RUN_TIMEOUT_MONITOR=yes|no
+          Whether CTDB should simulate timing out monitor
+          events. This uses the 99.timeout eventscript.
+
+          Default is no.
+
+       CTDB_VARDIR=DIRECTORY
+          DIRECTORY containing CTDB files that are modified at runtime.
+
+          Defaults to /usr/local/var/lib/ctdb.