]> git.ipfire.org Git - thirdparty/samba.git/commitdiff
ctdb-doc: Add some subsection names in description
authorMartin Schwenke <mschwenke@ddn.com>
Tue, 25 Jul 2023 02:19:07 +0000 (12:19 +1000)
committerAmitay Isaacs <amitay@samba.org>
Tue, 3 Oct 2023 03:53:35 +0000 (03:53 +0000)
A subsequent commit will add a new section, which looks out of place
without these new sections.

Best reviewed with "git show -w".

Signed-off-by: Martin Schwenke <mschwenke@ddn.com>
Reviewed-by: Amitay Isaacs <amitay@gmail.com>
ctdb/doc/ctdb-script.options.5.xml

index cd4b75bb51258ee02b0c2fff40db9960c8bc73c9..6da272e30a46d2bf65cd2060d8e8f5536c971a12 100644 (file)
   <refsect1>
     <title>DESCRIPTION</title>
 
-    <para>
-      Each CTDB script has 2 possible locations for its configuration options:
-    </para>
+    <refsect2>
+      <title>Location</title>
+      <para>
+       Each CTDB script has 2 possible locations for its configuration options:
+      </para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-       <term>
-         <filename>/usr/local/etc/ctdb/script.options</filename>
-       </term>
-       <listitem>
-         <para>
-           This is a catch-all global file for general purpose
-           scripts and for options that are used in multiple event
-           scripts.
-         </para>
-       </listitem>
-      </varlistentry>
+       <varlistentry>
+         <term>
+           <filename>/usr/local/etc/ctdb/script.options</filename>
+         </term>
+         <listitem>
+           <para>
+             This is a catch-all global file for general purpose
+             scripts and for options that are used in multiple event
+             scripts.
+           </para>
+         </listitem>
+       </varlistentry>
 
-      <varlistentry>
-       <term>
-         <parameter>SCRIPT</parameter>.options
-       </term>
-       <listitem>
-         <para>
-           That is, options for
-           <filename><parameter>SCRIPT</parameter></filename> are
-           placed in a file alongside the script, with a ".script"
-           suffix added.  This style is usually recommended for event
-           scripts.
-         </para>
+       <varlistentry>
+         <term>
+           <parameter>SCRIPT</parameter>.options
+         </term>
+         <listitem>
+           <para>
+             That is, options for
+             <filename><parameter>SCRIPT</parameter></filename> are
+             placed in a file alongside the script, with a ".script"
+             suffix added.  This style is usually recommended for event
+             scripts.
+           </para>
 
-         <para>
-           Options in this script-specific file override those in
-           the global file.
-         </para>
-       </listitem>
-      </varlistentry>
+           <para>
+             Options in this script-specific file override those in
+             the global file.
+           </para>
+         </listitem>
+       </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
 
-    <para>
-      These files should include simple shell-style variable
-      assignments and shell-style comments.
-    </para>
+    <refsect2>
+      <title>Contents</title>
+
+      <para>
+       These files should include simple shell-style variable
+       assignments and shell-style comments.
+      </para>
+    </refsect2>
 
   </refsect1>