Linkify mentions of the primary/subscriber's max_replication_slots
In the replication server configuration documentation[0]https://www.postgresql.org/docs/17/runtime-config-replication.html, 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]https://www.postgresql.org/docs/17/runtime-config-replication.html#GUC-MAX-REPLICATION-SLOTS:
[...]
Note that this parameter also applies on the subscriber side, but with
a different meaning.
and another time in the subscriber section[2]https://www.postgresql.org/docs/17/runtime-config-replication.html#GUC-MAX-REPLICATION-SLOTS-SUBSCRIBER:
[...]
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)
Attachments:
replication-docs.difftext/x-patch; charset=utf-8; name=replication-docs.diffDownload
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>
On Thu, Nov 7, 2024 at 9:36 AM Tristan Partin <tristan@partin.io> wrote:
Here is a patch which does so.
<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.<xref linkend="runtime-config-replication-sender"/> and <xref
linkend="runtime-config-replication-primary"/> are incorrect. They
should be instead <xref
linkend="runtime-config-replication-subscriber"/> and <xref
linkend="runtime-config-replication-sender"/>.
--
With Regards,
Amit Kapila.
On Thu, Nov 7, 2024 at 4:40 PM Amit Kapila <amit.kapila16@gmail.com> wrote:
On Thu, Nov 7, 2024 at 9:36 AM Tristan Partin <tristan@partin.io> wrote:
Here is a patch which does so.
<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.<xref linkend="runtime-config-replication-sender"/> and <xref
linkend="runtime-config-replication-primary"/> are incorrect. They
should be instead <xref
linkend="runtime-config-replication-subscriber"/> and <xref
linkend="runtime-config-replication-sender"/>.
I have made the required changes and pushed the patch.
--
With Regards,
Amit Kapila.
On Mon Nov 11, 2024 at 5:53 AM CST, Amit Kapila wrote:
On Thu, Nov 7, 2024 at 4:40 PM Amit Kapila <amit.kapila16@gmail.com> wrote:
On Thu, Nov 7, 2024 at 9:36 AM Tristan Partin <tristan@partin.io> wrote:
Here is a patch which does so.
<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.<xref linkend="runtime-config-replication-sender"/> and <xref
linkend="runtime-config-replication-primary"/> are incorrect. They
should be instead <xref
linkend="runtime-config-replication-subscriber"/> and <xref
linkend="runtime-config-replication-sender"/>.I have made the required changes and pushed the patch.
Thanks for your help in getting this over the line Amit 😄.
--
Tristan Partin
Neon (https://neon.tech)