Postgres Protocol Message Formats Clarification

From: PG Doc comments form <noreply(at)postgresql(dot)org>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: akindipejohn2017(at)gmail(dot)com
Subject: Postgres Protocol Message Formats Clarification
Date: 2026-07-11 14:24:07
Message-ID: 178377984700.881008.10843696440740337042@wrigleys.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: 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.

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2026-07-11 19:19:33 Re: 18.4. Managing Kernel Resources
Previous Message Fujii Masao 2026-07-10 13:29:47 Re: Fix data checksum progress reporting docs