Adjust the description of OutputPluginCallbacks in pg-doc

From: "wangw(dot)fnst(at)fujitsu(dot)com" <wangw(dot)fnst(at)fujitsu(dot)com>
To: "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Adjust the description of OutputPluginCallbacks in pg-doc
Date: 2023-01-11 10:50:28
Message-ID: OS3PR01MB627553DAFD39ECDADD08DC909EFC9@OS3PR01MB6275.jpnprd01.prod.outlook.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

When I was reading the "Logical Decoding Output Plugins" chapter in pg-doc [1],
I think in the summary section, only the callback message_cb is not described
whether it is required or optional, and the description of callback
stream_prepare_cb seems inaccurate.

And after the summary section, I think only the callback stream_xxx_cb section
and the callback truncate_cb section are not described this tag (are they
required or optional).

I think we could improve these to be more reader friendly. So I tried to write
a patch for these and attach it.

Any thoughts?

Regards,
Wang Wei

[1] - https://www.postgresql.org/docs/devel/logicaldecoding-output-plugin.html

Attachment Content-Type Size
v1-0001-Adjust-the-description-of-OutputPluginCallbacks-i.patch application/octet-stream 8.9 KB

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2023-01-11 11:05:34 Re: meson oddities
Previous Message Melih Mutlu 2023-01-11 10:44:30 Re: Allow logical replication to copy tables in binary format