doc: Clarify some terms for pg_createsubscriber
authorMichael Paquier <[email protected]>
Tue, 3 Dec 2024 07:21:07 +0000 (16:21 +0900)
committerMichael Paquier <[email protected]>
Tue, 3 Dec 2024 07:21:07 +0000 (16:21 +0900)
The last section of pg_createsubscriber used the terms
"publication-name", "replication-slot-name", and "subscription-name".
These terms are not defined on the page, which was confusing, and the
intention is clearly to refer to the values one would give to the
options --publication, --subscription and --replication-slot.  Let's
simplify the documentation by mentioning the option switches, instead of
these terms.

Reported-by: Christophe Courtois
Author: Shubham Khanna
Reviewed-by: Vignesh C, Peter Smith
Discussion: https://postgr.es/m/173288198026.714.15127074046508836738@wrigleys.postgresql.org
Backpatch-through: 17

doc/src/sgml/ref/pg_createsubscriber.sgml

index 04af154c4b4a477d18ca259428f0b248cecab40a..df1a92b4dad1a8465aa52b239498ce010ffd1ee3 100644 (file)
@@ -407,11 +407,11 @@ PostgreSQL documentation
       Create a publication and replication slot for each specified database on
       the source server.  Each publication is created using <link
       linkend="sql-createpublication-params-for-all-tables"><literal>FOR ALL
-      TABLES</literal></link>.  If <option>publication-name</option> option is
-      not specified, it has the following name pattern:
+      TABLES</literal></link>.  If the <option>--publication</option> option
+      is not specified, the publication has the following name pattern:
       <quote><literal>pg_createsubscriber_%u_%x</literal></quote> (parameter:
       database <parameter>oid</parameter>, random <parameter>int</parameter>).
-      If <option>replication-slot-name</option> is not specified, the
+      If the <option>--replication-slot</option> option is not specified, the
       replication slot has the following name pattern:
       <quote><literal>pg_createsubscriber_%u_%x</literal></quote> (parameters:
       database <parameter>oid</parameter>, random <parameter>int</parameter>).
@@ -446,8 +446,8 @@ PostgreSQL documentation
     <step>
      <para>
       Create a subscription for each specified database on the target server.
-      If <option>subscription-name</option> is not specified, the subscription
-      has the following name pattern:
+      If the <option>--subscription</option> option is not specified, the
+      subscription has the following name pattern:
       <quote><literal>pg_createsubscriber_%u_%x</literal></quote> (parameters:
       database <parameter>oid</parameter>, random <parameter>int</parameter>).
       It does not copy existing data from the source server.  It does not