Enhance create subscription reference manual - Mailing list pgsql-hackers

From Tatsuo Ishii
Subject Enhance create subscription reference manual
Date
Msg-id 20241002.121550.1929727821810759936.ishii@postgresql.org
Whole thread Raw
Responses Re: Enhance create subscription reference manual
List pgsql-hackers
Currently the manual explains create subscription's "failover"
parameter as follows:

         <para>
          Since no connection is made when this option is
          <literal>false</literal>, no tables are subscribed. To initiate
          replication, you must manually create the replication slot, enable
          the failover if required, enable the subscription, and refresh the
          subscription. See
          <xref linkend="logical-replication-subscription-examples-deferred-slot"/>
          for examples.
         </para>

While translating it into Japanese, we were little confused what "the
failover" actually means because we thought it might refer to the
failover operation or the failover parameter in the command. After a
discussion in the translation team, we concluded that it must refer to
the failover parameter. If we were correct, it would be nice to add
<literal> tag to "failover" to make it clear that it refers to a
failover parameter. Attached is the patch to do that.

Best reagards,
--
Tatsuo Ishii
SRA OSS K.K.
English: http://www.sraoss.co.jp/index_en/
Japanese:http://www.sraoss.co.jp
diff --git a/doc/src/sgml/ref/create_subscription.sgml b/doc/src/sgml/ref/create_subscription.sgml
index 740b7d9421..4eed0f3d0f 100644
--- a/doc/src/sgml/ref/create_subscription.sgml
+++ b/doc/src/sgml/ref/create_subscription.sgml
@@ -129,7 +129,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
           Since no connection is made when this option is
           <literal>false</literal>, no tables are subscribed. To initiate
           replication, you must manually create the replication slot, enable
-          the failover if required, enable the subscription, and refresh the
+          the <literal>failover</literal> if required, enable the subscription, and refresh the
           subscription. See
           <xref linkend="logical-replication-subscription-examples-deferred-slot"/>
           for examples.

pgsql-hackers by date:

Previous
From: Alexander Lakhin
Date:
Subject: Re: query_id, pg_stat_activity, extended query protocol
Next
From: Noah Misch
Date:
Subject: Re: pg_trgm comparison bug on cross-architecture replication due to different char implementation