In the replication server configuration documentation[0], there are 3 sections: sending, primary, standby, and subscriber. These sections mention various GUCs and how they apply to each server configuration.

The max_replication_slots GUC is mentioned twice, once in the sending section[1]:

[...]

Note that this parameter also applies on the subscriber side, but with a different meaning.

and another time in the subscriber section[2]:

[...]

Note that this parameter also applies on a sending server, but with a different meaning.

We can aid users that read these sections of the docs by adding links to the max_replication_slots GUC description which the texts refer to.

Here is a patch which does so.

[0]: https://www.postgresql.org/docs/17/runtime-config-replication.html
[1]: 
https://www.postgresql.org/docs/17/runtime-config-replication.html#GUC-MAX-REPLICATION-SLOTS
[2]: 
https://www.postgresql.org/docs/17/runtime-config-replication.html#GUC-MAX-REPLICATION-SLOTS-SUBSCRIBER

--
Tristan Partin
Neon (https://neon.tech)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index d54f904956..34b29fa13e 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4488,7 +4488,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
 
         <para>
          Note that this parameter also applies on the subscriber side, but with
-         a different meaning.
+         a different meaning. See <xref linkend="guc-max-replication-slots-subscriber"/>
+         in <xref linkend="runtime-config-replication-sender"/> for more
+         details.
         </para>
        </listitem>
       </varlistentry>
@@ -5215,7 +5217,9 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
 
        <para>
         Note that this parameter also applies on a sending server, but with
-        a different meaning.
+        a different meaning. See <xref linkend="guc-max-replication-slots"/>
+        in <xref linkend="runtime-config-replication-primary"/> for more
+        details.
        </para>
       </listitem>
      </varlistentry>

Reply via email to