Re: Trivial doc fix in logicaldecoding.sgml

From: Craig Ringer <craig(at)2ndquadrant(dot)com>
To: "Shulgin, Oleksandr" <oleksandr(dot)shulgin(at)zalando(dot)de>
Cc: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Trivial doc fix in logicaldecoding.sgml
Date: 2016-01-28 08:42:18
Message-ID: CAMsr+YFT5ocX=k=gSsoMBsGR7C9z0OqRpg8jM2=H62UH=VEwrA@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 28 January 2016 at 16:36, Shulgin, Oleksandr <
oleksandr(dot)shulgin(at)zalando(dot)de> wrote:

> On Thu, Jan 28, 2016 at 5:55 AM, Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
> wrote:
>
>> On Wed, Jan 27, 2016 at 7:34 PM, Shulgin, Oleksandr
>> <oleksandr(dot)shulgin(at)zalando(dot)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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Langote 2016-01-28 08:45:18 Re: Declarative partitioning
Previous Message Shulgin, Oleksandr 2016-01-28 08:36:06 Re: Trivial doc fix in logicaldecoding.sgml