Обсуждение: Re: Make pgoutput documentation easier to find

I applied the batch and built the html docs. I tested that all hyperlinks worked for me.

There are a few nit comments about wording:

diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 593f784b69d..4516650983d 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml

+    <xref linkend="test-decoding"/>.  You can also write custom output plugins

nit: "write" -> "develop"

+         Protocol version. Currently versions <literal>1</literal>, <literal>2</literal>,

"Protocol version." -> "Specifies the protocol version."

+         Comma-separated list of publication names for which to subscribe
+         (receive changes). The individual publication names are treated

A comma-separated list of publication names to subscribe to. The individual publication names are treated

+         Boolean option to use binary transfer mode.  Binary mode is faster

nit: "use" -> "enable", as other places all use "enable"

diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index e56eac8fd0f..9fe48c5acad 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml

+   The <literal>START_REPLICATION</literal> command allows us to
+   pass options to the logical decoding output plugin associated with
+   the replication slot specified in the command.
+   See <xref linkend="logicaldecoding-pgoutput-options"/> for options
+   that are accepted by the standard (<literal>pgoutput</literal>) plugin.

nit: The START_REPLICATION command can pass options to the logical decoding output plugin associated with the specified
replicationslot. See Section 47.6.1.1 for the options supported by the standard (pgoutput) plugin. 

The new status of this patch is: Waiting on Author

On Thu, Aug 14, 2025 at 1:05 PM Chao Li <li.evan.chao@gmail.com> wrote:
>
> I applied the batch and built the html docs. I tested that all hyperlinks worked for me.

Thanks for the review and testing!


> +    <xref linkend="test-decoding"/>.  You can also write custom output plugins
>
> nit: "write" -> "develop"

OK, updated. I've attached the updated version of the patch (0001).


> +         Protocol version. Currently versions <literal>1</literal>, <literal>2</literal>,
>
> "Protocol version." -> "Specifies the protocol version."
>
> +         Comma-separated list of publication names for which to subscribe
> +         (receive changes). The individual publication names are treated
>
> A comma-separated list of publication names to subscribe to. The individual publication names are treated
>
> +         Boolean option to use binary transfer mode.  Binary mode is faster
>
> nit: "use" -> "enable", as other places all use "enable"

The 0001 patch mainly moves the pgoutput docs to a more visible location.
On the other hand, it looks like you're also suggesting further improvements
to the docs. I agree this is worth doing, but I think it should be a separate
patch. So I've created 0002, which updates the docs based on your comments
and also improves several other descriptions.


> +   The <literal>START_REPLICATION</literal> command allows us to
> +   pass options to the logical decoding output plugin associated with
> +   the replication slot specified in the command.
> +   See <xref linkend="logicaldecoding-pgoutput-options"/> for options
> +   that are accepted by the standard (<literal>pgoutput</literal>) plugin.
>
> nit: The START_REPLICATION command can pass options to the logical decoding output plugin associated with the
specifiedreplication slot. See Section 47.6.1.1 for the options supported by the standard (pgoutput) plugin. 

OK, updated (0001 patch).

Regards,

--
Fujii Masao

Dear Fujii-san,

Thanks for updating the patch. Your patches look good to me.

Best regards,
Hayato Kuroda
FUJITSU LIMITED

On Fri, Aug 15, 2025 at 1:46 PM Hayato Kuroda (Fujitsu)
<kuroda.hayato@fujitsu.com> wrote:
>
> Dear Fujii-san,
>
> Thanks for updating the patch. Your patches look good to me.

Thanks for the review! Unless there are objections, I'll commit these
two patches.

Regards,

--
Fujii Masao

On Mon, Aug 18, 2025 at 11:55 AM Fujii Masao <masao.fujii@gmail.com> wrote:
>
> On Fri, Aug 15, 2025 at 1:46 PM Hayato Kuroda (Fujitsu)
> <kuroda.hayato@fujitsu.com> wrote:
> >
> > Dear Fujii-san,
> >
> > Thanks for updating the patch. Your patches look good to me.
>
> Thanks for the review! Unless there are objections, I'll commit these
> two patches.

I've pushed the patches. Thanks!

Regards,

--
Fujii Masao