standby clone: rename --recovery-conf-only to --replication-conf-only

A more generic option name to cover pre- and post-Pg12 replication
configuration methods.

--recovery-conf-only is retained as an alias for backwards
compatibility.

doc/appendix-faq.xml

@@ -245,7 +245,7 @@
       <para>
         For a standby which has been manually cloned or recovered from an external
         backup manager such as Barman, the command
-        <command><link linkend="repmgr-standby-clone">repmgr standby clone --recovery-conf-only</link></command>
+        <command><link linkend="repmgr-standby-clone">repmgr standby clone --replication-conf-only</link></command>
         can be used to create the correct <filename>recovery.conf</filename> file for
         use with &repmgr; (and will create a replication slot if required). Once this has been done,
         <link linkend="repmgr-standby-register">register the node</link> as usual.

doc/appendix-release-notes.xml

@@ -17,6 +17,36 @@
 
 <!-- remember to update the release date in ../repmgr_version.h.in -->
 
+  <sect1 id="release-5.1.0">
+    <title>Release 5.1.0</title>
+    <para><emphasis>?? ?? ??, 20??</emphasis></para>
+
+    <para>
+      &repmgr; 5.1.0 is a major release.
+    </para>
+    <para>
+      For details on how to upgrade an existing &repmgr; installation, see
+      documentation section <link linkend="upgrading-major-version">Upgrading a major version release</link>.
+    </para>
+    <para>
+      If &repmgrd; is in use, a PostgreSQL restart <emphasis>is</emphasis> required;
+      in that case we suggest combining this &repmgr; upgrade with the next PostgreSQL
+      minor release, which will require a PostgreSQL restart in any case.
+    </para>
+
+
+    <sect2>
+      <title>Compatibility changes</title>
+      <para>
+        The <link linkend="repmgr-standby-clone"><command>repmgr standby clone</command></link>
+        <option>--recovery-conf-only</option> option has been renamed to
+        <option>--replication-conf-only</option>. <option>--recovery-conf-only</option> will
+        still be accepted as an alias.
+      </para>
+    </sect2>
+
+  </sect1>
+
   <sect1 id="release-5.0">
     <title id="release-current">Release 5.0</title>
     <para><emphasis>Tue 15 October, 2019</emphasis></para>

doc/cloning-standbys.xml

@@ -64,8 +64,9 @@
     </para>
     <para>
       Barman's parallel restore facility can be used by executing it manually on
-      the Barman server and integrating the resulting cloned standby using
-      <command><link linkend="repmgr-standby-clone">repmgr standby clone --recovery-conf-only</link></command>.
+      the Barman server and configuring replication on the resulting cloned
+      standby using
+      <command><link linkend="repmgr-standby-clone">repmgr standby clone --replication-conf-only</link></command>.
     </para>
    </note>
 

doc/repmgr-standby-clone.xml

@@ -188,18 +188,18 @@
    </note>
   </refsect1>
 
-
+<!-- don't rename this id as it may be used in external links -->
   <refsect1 id="repmgr-standby-create-recovery-conf">
 
    <title>Using a standby cloned by another method</title>
 
    <indexterm>
-     <primary>recovery.conf</primary>
+     <primary>replication configuration</primary>
      <secondary>generating for a standby cloned by another method</secondary>
    </indexterm>
 
    <indexterm>
-     <primary>replication configuration</primary>
+     <primary>recovery.conf</primary>
      <secondary>generating for a standby cloned by another method</secondary>
    </indexterm>
 
@@ -224,7 +224,7 @@
      </para>
    </tip>
    <para>
-     Then execute the command <command>repmgr standby clone --recovery-conf-only</command>.
+     Then execute the command <command>repmgr standby clone --replication-conf-only</command>.
      This will create the <filename>recovery.conf</filename> file needed to attach
      the node to its upstream (in PostgreSQL 12 and later: append replication configuration
      to <filename>postgresql.auto.conf</filename>), and will also create a replication slot on the
@@ -236,7 +236,7 @@
      <option>-F/--force</option> option is provided.
    </para>
    <para>
-     Execute <command>repmgr standby clone --recovery-conf-only --dry-run</command>
+     Execute <command>repmgr standby clone --replication-conf-only --dry-run</command>
      to check the prerequisites for creating the recovery configuration,
      and display the contents of the configuration which would be added without actually
 	 making any changes.
@@ -266,7 +266,7 @@
             Check prerequisites but don't actually clone the standby.
           </para>
           <para>
-            If <option>--recovery-conf-only</option> specified, the contents of
+            If <option>--replication-conf-only</option> specified, the contents of
             the generated recovery configuration will be displayed
             but not written.
           </para>
@@ -312,7 +312,7 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option> --recovery-conf-only</option></term>
+        <term><option>--replication-conf-only</option></term>
         <listitem>
           <para>
             Create recovery configuration for a previously cloned instance.

doc/repmgr-standby-register.xml

@@ -111,7 +111,7 @@
      <command><ulink url="https://docs.pgbarman.org/#recover">barman recover</ulink></command>
      command), register the node as detailed in section
      <xref linkend="repmgr-standby-register-inactive-node"/> then execute
-     <link linkend="repmgr-standby-create-recovery-conf">repmgr standby clone --recovery-conf-only</link>
+     <link linkend="repmgr-standby-create-recovery-conf">repmgr standby clone --replication-conf-only</link>
      to generate the appropriate replication configuration.
     </para>
   </refsect1>