Trivial doc fix in logicaldecoding.sgml

Started by Shulgin, Oleksandralmost 10 years ago6 messages

Shulgin, Oleksandr

oleksandr.shulgin@zalando.de

almost 10 years ago

1 attachment(s)

Hi,

Please find attached a simple copy-paste fix for CREATE_REPLICATION_SLOT
syntax.

--
Alex

Attachments:

0001-Fix-CREATE_REPLICATION_SLOT-syntax-in-logicaldecodin.patchtext/x-patch; charset=US-ASCII; name=0001-Fix-CREATE_REPLICATION_SLOT-syntax-in-logicaldecodin.patchDownload

From 05119485a473febe8ffd95103fd7774bc31ee079 Mon Sep 17 00:00:00 2001
From: Oleksandr Shulgin <oleksandr.shulgin@zalando.de>
Date: Wed, 27 Jan 2016 11:27:35 +0100
Subject: [PATCH] Fix CREATE_REPLICATION_SLOT syntax in logicaldecoding.sgml

---
 doc/src/sgml/logicaldecoding.sgml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 1ae5eb6..926637b 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -280,7 +280,7 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
     The commands
     <itemizedlist>
      <listitem>
-      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
+      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>output_plugin</replaceable></literal></para>
      </listitem>
 
      <listitem>
-- 
2.5.0

Fujii Masao

masao.fujii@gmail.com

almost 10 years ago

In reply to: Shulgin, Oleksandr (#1)

Re: Trivial doc fix in logicaldecoding.sgml

On Wed, Jan 27, 2016 at 7:34 PM, Shulgin, Oleksandr
<oleksandr.shulgin@zalando.de> wrote:

Hi,

Please find attached a simple copy-paste fix for CREATE_REPLICATION_SLOT
syntax.

We should change also START_REPLICATION SLOT syntax document as follows?

-      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>XXX/XXX</replaceable>
(<replaceable>options</replaceable>)</literal></para>

Regards,

--
Fujii Masao

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

Shulgin, Oleksandr

oleksandr.shulgin@zalando.de

almost 10 years ago

In reply to: Fujii Masao (#2)

Re: Trivial doc fix in logicaldecoding.sgml

On Thu, Jan 28, 2016 at 5:55 AM, Fujii Masao <masao.fujii@gmail.com> wrote:

On Wed, Jan 27, 2016 at 7:34 PM, Shulgin, Oleksandr
<oleksandr.shulgin@zalando.de> wrote:

Hi,

Please find attached a simple copy-paste fix for CREATE_REPLICATION_SLOT
syntax.

We should change also START_REPLICATION SLOT syntax document as follows?
-      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>XXX/XXX</replaceable>
(<replaceable>options</replaceable>)</literal></para>

If a committer would thinks so, I don't object. Though this one is rather
a detail for which the reader is already referred to protocol-replication,
while my fix was about a factual error.

--
Alex

Craig Ringer

craig@2ndquadrant.com

almost 10 years ago

In reply to: Shulgin, Oleksandr (#3)

Re: Trivial doc fix in logicaldecoding.sgml

On 28 January 2016 at 16:36, Shulgin, Oleksandr <
oleksandr.shulgin@zalando.de> wrote:

On Thu, Jan 28, 2016 at 5:55 AM, Fujii Masao <masao.fujii@gmail.com>
wrote:
On Wed, Jan 27, 2016 at 7:34 PM, Shulgin, Oleksandr
<oleksandr.shulgin@zalando.de> wrote:

Hi,

Please find attached a simple copy-paste fix for CREATE_REPLICATION_SLOT
syntax.

We should change also START_REPLICATION SLOT syntax document as follows?
-      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>XXX/XXX</replaceable>
(<replaceable>options</replaceable>)</literal></para>
If a committer would thinks so, I don't object. Though this one is rather
a detail for which the reader is already referred to protocol-replication,
while my fix was about a factual error.

I think it should be changed. I've already had people confused by this.

Either that or remove the synopsis entirely, changing it to

START_REPLICATION SLOT ....

and linking to the protocol docs. Which might be better.

--
Craig Ringer http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

Shulgin, Oleksandr

oleksandr.shulgin@zalando.de

almost 10 years ago

In reply to: Craig Ringer (#4)

1 attachment(s)

Re: Trivial doc fix in logicaldecoding.sgml

On Thu, Jan 28, 2016 at 9:42 AM, Craig Ringer <craig@2ndquadrant.com> wrote:

On 28 January 2016 at 16:36, Shulgin, Oleksandr <

oleksandr.shulgin@zalando.de> wrote:

On Thu, Jan 28, 2016 at 5:55 AM, Fujii Masao <masao.fujii@gmail.com>

wrote:

We should change also START_REPLICATION SLOT syntax document as follows?
-      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>XXX/XXX</replaceable>
(<replaceable>options</replaceable>)</literal></para>
If a committer would thinks so, I don't object. Though this one is

rather a detail for which the reader is already referred to
protocol-replication, while my fix was about a factual error.

I think it should be changed. I've already had people confused by this.

Either that or remove the synopsis entirely, changing it to

START_REPLICATION SLOT ....

and linking to the protocol docs. Which might be better.

I think it still makes sense to keep the LOGICAL, but hide the rest of the
details behind that ellipsis, so:

START_REPLICATION SLOT slot_name LOGICAL ...

Updated patch attached.

--
Alex

Attachments:

0001-Fix-protocol-commands-description-in-logicaldecoding.patchtext/x-patch; charset=US-ASCII; name=0001-Fix-protocol-commands-description-in-logicaldecoding.patchDownload

From 11b61d04cd16b9577759edff15e68f8ba9c4828e Mon Sep 17 00:00:00 2001
From: Oleksandr Shulgin <oleksandr.shulgin@zalando.de>
Date: Wed, 27 Jan 2016 11:27:35 +0100
Subject: [PATCH] Fix protocol commands description in logicaldecoding.sgml

---
 doc/src/sgml/logicaldecoding.sgml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 1ae5eb6..e841348 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -280,7 +280,7 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
     The commands
     <itemizedlist>
      <listitem>
-      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
+      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>output_plugin</replaceable></literal></para>
      </listitem>
 
      <listitem>
@@ -288,7 +288,7 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
      </listitem>
 
      <listitem>
-      <para><literal>START_REPLICATION SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT <replaceable>slot_name</replaceable> LOGICAL ...</literal></para>
      </listitem>
     </itemizedlist>
     are used to create, drop, and stream changes from a replication
-- 
2.5.0

Fujii Masao

masao.fujii@gmail.com

almost 10 years ago

In reply to: Shulgin, Oleksandr (#5)

Re: Trivial doc fix in logicaldecoding.sgml

On Thu, Jan 28, 2016 at 6:08 PM, Shulgin, Oleksandr
<oleksandr.shulgin@zalando.de> wrote:

On Thu, Jan 28, 2016 at 9:42 AM, Craig Ringer <craig@2ndquadrant.com> wrote:
On 28 January 2016 at 16:36, Shulgin, Oleksandr
<oleksandr.shulgin@zalando.de> wrote:
On Thu, Jan 28, 2016 at 5:55 AM, Fujii Masao <masao.fujii@gmail.com>
wrote:
We should change also START_REPLICATION SLOT syntax document as follows?
-      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT
<replaceable>slot_name</replaceable> LOGICAL
<replaceable>XXX/XXX</replaceable>
(<replaceable>options</replaceable>)</literal></para>
If a committer would thinks so, I don't object. Though this one is
rather a detail for which the reader is already referred to
protocol-replication, while my fix was about a factual error.
I think it should be changed. I've already had people confused by this.

Either that or remove the synopsis entirely, changing it to

START_REPLICATION SLOT ....

and linking to the protocol docs. Which might be better.
I think it still makes sense to keep the LOGICAL, but hide the rest of the
details behind that ellipsis, so:

START_REPLICATION SLOT slot_name LOGICAL ...

Updated patch attached.

Okay, pushed. Thanks!

Regards,

--
Fujii Masao

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers