Re: Make pgoutput documentation easier to find

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

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 replication slot. 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

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Hayato Kuroda (Fujitsu) 2025-08-14 12:12:44 RE: Make pgoutput documentation easier to find
Previous Message Fujii Masao 2025-08-14 02:49:32 Re: Index / glossary adjustments for Git & GUC

Browse pgsql-hackers by date

  From Date Subject
Next Message Fujii Masao 2025-08-14 04:08:40 Re: Excessive LOG messages from replication slot sync worker
Previous Message shveta malik 2025-08-14 03:45:33 Re: Conflict detection for update_deleted in logical replication