Re: [PATCH] Explain what the default output_plugin_libraries do

From: Jacob Champion <jacob(dot)champion(at)enterprisedb(dot)com>
To: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>
Cc: Bharath Rupireddy <bharath(dot)rupireddyforpostgres(at)gmail(dot)com>, "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com>, Fujii Masao <masao(dot)fujii(at)gmail(dot)com>, "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: [PATCH] Explain what the default output_plugin_libraries do
Date: 2026-09-22 20:56:35
Message-ID: CAOYmi+kR3KCwB67TbCEg6djNVv_wYiasit04mxYT+0oFzi4mFQ@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Mon, Sep 21, 2026 at 11:09 PM Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> wrote:
> I tried to build the HTML page, and see that <xref linkend="guc-output-plugin-libraries-builtins”/> is rendered as “Table 19.2”, so it looks like “(Table 19.2 documents ….)”,

Right. (I've attached a sample screenshot for everyone.)

> which looks a little awkward.

Any particular reason?

> How about not using parentheses, and just say something like: See <xref linkend="guc-output-plugin-libraries-builtins"/> for the effects of removing these plugins from the list.

Mm, it's easier for my brain to figure out *why* we're saying it with
the parenthetical, because it's meant to be an aside. "If you're
motivated to remove these, maybe take a look at what they do first.
Otherwise, don't worry about it and keep reading." It's the sort of
thing a book might use a footnote for, but it's really difficult to
use footnotes well on these pages.

--

Thanks everybody for the reviews! v2 has the backpatchable piece. It
doesn't incorporate Kuroda-san's suggested new section from upthread,
since that's master-only and can be committed separately once we have
the wording we like.

--Jacob

Attachment Content-Type Size
sample.png image/png 140.8 KB
v2-0001-doc-Improve-output_plugin_libraries-documentation.patch application/octet-stream 4.2 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Manu 2026-09-22 20:58:59 Re: Extension security improvement: Add support for extensions with an owned schema
Previous Message Euler Taveira 2026-09-22 20:51:44 Re: Teach pg_upgrade to deal with invalid databases