Re: Make pgoutput documentation easier to find - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: Make pgoutput documentation easier to find
Date
Msg-id 900b7421-1f32-47c7-9ad2-4144dfd7b679@eisentraut.org
Whole thread Raw
In response to Make pgoutput documentation easier to find  (Fujii Masao <masao.fujii@gmail.com>)
Responses Re: Make pgoutput documentation easier to find
List 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.




pgsql-docs by date:

Previous
From: Oleg Tselebrovskiy
Date:
Subject: Re: Initcap works differently with different locale providers
Next
From: Peter Eisentraut
Date:
Subject: Re: Initcap works differently with different locale providers