public inbox for [email protected]  
help / color / mirror / Atom feed
From: Michael Paquier <[email protected]>
To: Daniel Gustafsson <[email protected]>
Cc: [email protected]
Subject: Re: Documentation on Streaming Replication interface for Logical Decoding
Date: Tue, 10 Nov 2015 13:59:27 +0900
Message-ID: <CAB7nPqRHfmgU3eFT4OZuDMFCzQP6Y35H3=y_iNKBu-k-d_iO-w@mail.gmail.com> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
List-Unsubscribe: <mailto:[email protected]?body=unsub%20pgsql-docs>

On Tue, Nov 10, 2015 at 7:40 AM, Daniel Gustafsson <[email protected]> wrote:
> In section 46.3 (Streaming Replication Protocol Interface) the create command
> for logical slots, CREATE_REPLICATION_SLOT, is defined as taking “options”
> after the LOGICAL keyword when it in fact requires the plugin name.  The start
> command is correctly listing the options but isn’t listing the required start
> position.
>
> The attached patch synchronizes these command signatures with the more detailed
> descriptions in section 50.3* (Streaming Replication Protocol).
>
>         cheers ./daniel
>
> (*) Section number from the 9.5beta1 manual

Why do we need to maintain the semantics of those commands in two
places by the way? There is already a link to the replication protocol
page in logicaldecoding.sgml, hence it seems to me that we had better
just cite the command names, per se the attached.
-- 
Michael


-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs


Attachments:

  [text/x-diff] 20151110_logdec_docs.patch (1.5K, 2-20151110_logdec_docs.patch)
  download | inline diff:
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 02794cc..11fc715 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -277,23 +277,11 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
    <title>Streaming Replication Protocol Interface</title>
 
    <para>
-    The commands
-    <itemizedlist>
-     <listitem>
-      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
-     </listitem>
-
-     <listitem>
-      <para><literal>DROP_REPLICATION_SLOT <replaceable>slot_name</replaceable></literal></para>
-     </listitem>
-
-     <listitem>
-      <para><literal>START_REPLICATION SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
-     </listitem>
-    </itemizedlist>
-    are used to create, drop, and stream changes from a replication
-    slot, respectively. These commands are only available over a replication
-    connection; they cannot be used via SQL.
+    The commands <literal>CREATE_REPLICATION_SLOT</literal>,
+    <literal>DROP_REPLICATION_SLOT</literal> and 
+    <literal>START_REPLICATION SLOT</literal> are used to create, drop, and
+    stream changes from a replication slot, respectively. These commands are
+    only available over a replication connection; they cannot be used via SQL.
     See <xref linkend="protocol-replication"> for details on these commands.
    </para>
 


view thread (3+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: Documentation on Streaming Replication interface for Logical Decoding
  In-Reply-To: <CAB7nPqRHfmgU3eFT4OZuDMFCzQP6Y35H3=y_iNKBu-k-d_iO-w@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox