Re: Trivial doc fix in logicaldecoding.sgml

From: "Shulgin, Oleksandr" <oleksandr(dot)shulgin(at)zalando(dot)de>
To: Craig Ringer <craig(at)2ndquadrant(dot)com>
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 09:08:17
Message-ID: CACACo5RRUv_Zb1u5FkRoSdLt9r0j0xM=GKQ1o+w6dzkHWDN5qg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Thu, Jan 28, 2016 at 9:42 AM, Craig Ringer <craig(at)2ndquadrant(dot)com> wrote:
>
>
> 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:
>>>
>>>
>>> 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

Attachment Content-Type Size
0001-Fix-protocol-commands-description-in-logicaldecoding.patch text/x-patch 1.4 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Pavel Stehule 2016-01-28 09:10:58 Re: [PATCH] better systemd integration
Previous Message Pavel Stehule 2016-01-28 09:00:35 Re: [PATCH] better systemd integration