Re: Make pgoutput documentation easier to find

Peter Eisentraut <peter@eisentraut.org>

From: Peter Eisentraut <peter@eisentraut.org>
To: Fujii Masao <masao.fujii@gmail.com>, pgsql-docs@lists.postgresql.org
Date: 2025-08-06T11:36:21Z
Lists: pgsql-hackers, pgsql-docs
On 03.08.25 03:32, Fujii Masao wrote:
> The current documentation for pgoutput is buried in the logical streaming
> replication protocol section (in protocol.sgml), and there's no index entry
> for it. This makes it hard to discover and access, for example, when trying
> to look up the options it supports.
> 
> I've often struggled to locate this information myself, so I'd like to
> propose moving the pgoutput documentation to the logical decoding section
> and adding an index entry. The attached patch does that. I think this change
> will make it much easier for users to find the relevant details.

This would move the documentation of pgoutput from "Internals" to 
"Server Programming".  So it's a question of whether this is something 
we want to advertise that people can use directly.  In the past, 
pgoutput was an implementation detail of logical replication.  But I 
gather people are using it for other things now?  Still not clear what 
kind of guarantees we want to give about its interfaces, for example.




Commits

  1. doc: Improve pgoutput documentation.

  2. doc: Improve documentation discoverability for pgoutput.

  3. Use PG_MODULE_MAGIC_EXT in our installable shared libraries.