From 36a09a5c4b9516144ef31a6547700a412300cd80 Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Fri, 7 Jun 2019 12:16:04 +0900
Subject: [PATCH] doc: improve configuration documentation

---
 doc/configuration-file-required-settings.xml | 27 ---------
 doc/configuration-file.xml                   | 58 ++++++++++++++++++++
 repmgr.conf.sample                           |  1 -
 3 files changed, 58 insertions(+), 28 deletions(-)

diff --git a/doc/configuration-file-required-settings.xml b/doc/configuration-file-required-settings.xml
index 5f241f68..b4858ce5 100644
--- a/doc/configuration-file-required-settings.xml
+++ b/doc/configuration-file-required-settings.xml
@@ -96,33 +96,6 @@
   </variablelist>
  </para>
 
-  <para>
-    For a full list of annotated configuration items, see the file
-    <ulink url="https://raw.githubusercontent.com/2ndQuadrant/repmgr/master/repmgr.conf.sample">repmgr.conf.sample</ulink>.
-  </para>
-  <para>
-    For &repmgrd;-specific settings, see <xref linkend="repmgrd-configuration"/>.
-  </para>
 
-  <note>
-    <para>
-    The following parameters in the configuration file can be overridden with
-    command line options:
-    <itemizedlist>
-     <listitem>
-       <simpara>
-         <literal>-L/--log-level</literal> overrides <literal>log_level</literal> in
-         <filename>repmgr.conf</filename>
-       </simpara>
-     </listitem>
-     <listitem>
-       <simpara>
-         <literal>-b/--pg_bindir</literal> overrides <literal>pg_bindir</literal> in
-         <filename>repmgr.conf</filename>
-       </simpara>
-     </listitem>
-    </itemizedlist>
-    </para>
-  </note>
 
 </sect1>
diff --git a/doc/configuration-file.xml b/doc/configuration-file.xml
index a53effaa..fd748701 100644
--- a/doc/configuration-file.xml
+++ b/doc/configuration-file.xml
@@ -62,6 +62,64 @@ data_directory = /var/lib/pgsql/11/data</programlisting>
   </sect2>
 
 
+  <sect2 id="configuration-file-items" xreflabel="configuration file items">
+
+    <title>Configuration file items</title>
+    <para>
+      The following sections document some sections of the configuration file:
+       <itemizedlist>
+          <listitem>
+            <simpara>
+              <xref linkend="configuration-file-settings"/>
+            </simpara>
+          </listitem>
+
+          <listitem>
+            <simpara>
+              <xref linkend="configuration-file-log-settings"/>
+            </simpara>
+          </listitem>
+
+
+          <listitem>
+            <simpara>
+              <xref linkend="configuration-file-service-commands"/>
+            </simpara>
+          </listitem>
+
+       </itemizedlist>
+
+    </para>
+    <para>
+      For a full list of annotated configuration items, see the file
+      <ulink url="https://raw.githubusercontent.com/2ndQuadrant/repmgr/master/repmgr.conf.sample">repmgr.conf.sample</ulink>.
+    </para>
+    <para>
+      For &repmgrd;-specific settings, see <xref linkend="repmgrd-configuration"/>.
+    </para>
+
+    <note>
+      <para>
+        The following parameters in the configuration file can be overridden with
+        command line options:
+        <itemizedlist>
+          <listitem>
+            <simpara>
+              <literal>-L/--log-level</literal> overrides <literal>log_level</literal> in
+              <filename>repmgr.conf</filename>
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara>
+              <literal>-b/--pg_bindir</literal> overrides <literal>pg_bindir</literal> in
+              <filename>repmgr.conf</filename>
+            </simpara>
+          </listitem>
+        </itemizedlist>
+      </para>
+    </note>
+
+  </sect2>
 
   <sect2 id="configuration-file-location" xreflabel="configuration file location">
   <title>Configuration file location</title>
diff --git a/repmgr.conf.sample b/repmgr.conf.sample
index 7f0b5554..28511cac 100644
--- a/repmgr.conf.sample
+++ b/repmgr.conf.sample
@@ -51,7 +51,6 @@
 
 
 # =============================================================================
-
 # Optional configuration items
 # =============================================================================