Re: Make pgoutput documentation easier to find

From: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
To: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>
Cc: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Make pgoutput documentation easier to find
Date: 2025-08-14 16:05:48
Message-ID: CAHGQGwGsL5k7NR4PZtSGYX=wLpki=UX5gCwCdMPtoctgT6uiCA@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On Thu, Aug 14, 2025 at 1:05 PM Chao Li <li(dot)evan(dot)chao(at)gmail(dot)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 specified replication slot. See Section 47.6.1.1 for the options supported by the standard (pgoutput) plugin.

OK, updated (0001 patch).

Regards,

--
Fujii Masao

Attachment Content-Type Size
v2-0002-doc-Improve-pgoutput-docs.patch application/octet-stream 8.7 KB
v2-0001-doc-Improve-documentation-discoverability-for-pgo.patch application/octet-stream 12.7 KB

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Fujii Masao 2025-08-14 16:10:58 Re: Make pgoutput documentation easier to find
Previous Message Álvaro Herrera 2025-08-14 12:24:45 Re: Broken NewbieDoc Docbook Guide link

Browse pgsql-hackers by date

  From Date Subject
Next Message Fujii Masao 2025-08-14 16:10:58 Re: Make pgoutput documentation easier to find
Previous Message David Rowley 2025-08-14 15:59:20 Re: [PATCH] bms_prev_member() can read beyond the end of the array of allocated words