Postgres Protocol Message Formats Clarification - Mailing list pgsql-docs

From PG Doc comments form
Subject Postgres Protocol Message Formats Clarification
Date
Msg-id 178377984700.881008.10843696440740337042@wrigleys.postgresql.org
Whole thread
Responses Re: Postgres Protocol Message Formats Clarification
List pgsql-docs
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/18/protocol-message-formats.html
Description:

While the docs correctly state here
(https://www.postgresql.org/docs/current/protocol-overview.html#PROTOCOL-MESSAGE-CONCEPTS)
that the size bytes represent the length of the message except the first
byte (the msg type byte), this page
(https://www.postgresql.org/docs/current/protocol-message-formats.html#PROTOCOL-MESSAGE-FORMATS)
which explicitly describes the message formats does not include this
clarification.

Readers who come across this page without reading the protocol overview page
will be quite confused should they try to implement the protocol and see
short by one message sizes.

I propose that this clarification be more explicitly added to the message
formats page to avoid confusing readers.




pgsql-docs by date:

Previous
From: Fujii Masao
Date:
Subject: Re: Fix data checksum progress reporting docs
Next
From: Tom Lane
Date:
Subject: Re: 18.4. Managing Kernel Resources