Re: [PATCH] Explain what the default output_plugin_libraries do - Mailing list pgsql-hackers

From Jacob Champion
Subject Re: [PATCH] Explain what the default output_plugin_libraries do
Date
Msg-id CAOYmi+kR3KCwB67TbCEg6djNVv_wYiasit04mxYT+0oFzi4mFQ@mail.gmail.com
Whole thread
In response to Re: [PATCH] Explain what the default output_plugin_libraries do  (Chao Li <li.evan.chao@gmail.com>)
Responses Re: [PATCH] Explain what the default output_plugin_libraries do
List pgsql-hackers
On Mon, Sep 21, 2026 at 11:09 PM Chao Li <li.evan.chao@gmail.com> wrote:
> I tried to build the HTML page, and see that <xref linkend="guc-output-plugin-libraries-builtins”/> is rendered as
“Table19.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

pgsql-hackers by date:

Previous
From: "Euler Taveira"
Date:
Subject: Re: Teach pg_upgrade to deal with invalid databases
Next
From: Manu
Date:
Subject: Re: Extension security improvement: Add support for extensions with an owned schema