Re: Adjust the description of OutputPluginCallbacks in pg-doc

From: Amit Kapila <amit(dot)kapila16(at)gmail(dot)com>
To: "wangw(dot)fnst(at)fujitsu(dot)com" <wangw(dot)fnst(at)fujitsu(dot)com>
Cc: "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Adjust the description of OutputPluginCallbacks in pg-doc
Date: 2023-01-19 11:17:38
Message-ID: CAA4eK1J8iWB9RG2OgdoLDYSDOfK4Qu530Ep8j=0XoEy7s+ih0w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Jan 11, 2023 at 4:20 PM wangw(dot)fnst(at)fujitsu(dot)com
<wangw(dot)fnst(at)fujitsu(dot)com> wrote:
>
> 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?
>

This looks mostly good to me. I have made minor adjustments in the
attached. Do those make sense to you?

--
With Regards,
Amit Kapila.

Attachment Content-Type Size
v2-0001-Improve-the-description-of-Output-Plugin-Callback.patch application/octet-stream 9.1 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message vignesh C 2023-01-19 11:17:57 Re: pg_stat_bgwriter.buffers_backend is pretty meaningless (and more?)
Previous Message Amit Langote 2023-01-19 11:16:16 Re: ExecRTCheckPerms() and many prunable partitions (checkAsUser)