Re: Correct documentation for protocol version - Mailing list pgsql-hackers

From Heikki Linnakangas
Subject Re: Correct documentation for protocol version
Date
Msg-id 2bef778b-273d-4b08-8adc-bd4d31b47e64@iki.fi
Whole thread Raw
In response to Correct documentation for protocol version  (Dave Cramer <davecramer@gmail.com>)
Responses Re: Correct documentation for protocol version
List pgsql-hackers
On 27/06/2025 14:20, Dave Cramer wrote:
> 
> 
> On Thu, 26 Jun 2025 at 18:04, Jelte Fennema-Nio <postgres@jeltef.nl 
> <mailto:postgres@jeltef.nl>> wrote:
> 
>     On Fri, 30 May 2025 at 11:00, Jelte Fennema-Nio <postgres@jeltef.nl
>     <mailto:postgres@jeltef.nl>> wrote:
>      > If we decide to keep it I think it would be best to have all protocol
>      > changes on a single page. I'd just put the changes from 2.0 to 3.0 at
>      > the bottom of the page.
> 
>     Attached are my proposed changes which split this page into different
>     sections, one for each protocol version, with the most recent protocol
>     changes at the top.
> 
> 
> Thanks Jelte,
> 
> Looks good to me

This is largely redundant with the table in section 54.1.4. Protocol 
Versions 
(https://www.postgresql.org/docs/devel/protocol-overview.html#PROTOCOL-VERSIONS).

I like the details you added on the changes introduced without protocol 
bump in v3.0, though.

I'm not sure what exactly to do here. The current docs could certainly 
be improved, but this patch isn't quite there yet. Some thoughts/opinions:

* I would like to have more separation between the obsolete v2 protocol 
and v3 onwards. The v2 section should be more tucked away.

* I think a table, like in the section 54.1.4 Protocol Versions section, 
  is better than just text paragraphs. Could have text paragraphs with 
more details, but a table gives a good overview.

* The first paragraph in the "Summary of Protocol Changes" section says 
"This section provides a quick checklist of changes", but it's more like 
an exhaustive list now.

- Heikki




pgsql-hackers by date:

Previous
From: Kirill Reshke
Date:
Subject: Re: VM corruption on standby
Next
From: Shlok Kyal
Date:
Subject: Re: POC: enable logical decoding when wal_level = 'replica' without a server restart