public inbox for [email protected]  
help / color / mirror / Atom feed
From: Jelte Fennema-Nio <[email protected]>
To: [email protected]
Subject: docs: Link to the correct protocol version inspection function
Date: Wed, 22 Oct 2025 11:42:07 +0200
Message-ID: <CAGECzQSKFxQsYAgr11PhdOr-RtPZEdAXZnHx6U3avLuk3xQaTQ@mail.gmail.com> (raw)

The docs for max_protocol_version suggested PQprotocolVersion instead of
PQfullProtocolVersion to find out the exact protocol version. Since
PQprotocolVersion only returns the major protocol version that is bad
advice.


Attachments:

  [application/x-patch] v1-0001-docs-Link-to-the-correct-protocol-version-inspect.patch (1.3K, 2-v1-0001-docs-Link-to-the-correct-protocol-version-inspect.patch)
  download | inline diff:
From e57dceb0d2b57c9ce99a843342cb821537d3b504 Mon Sep 17 00:00:00 2001
From: Jelte Fennema-Nio <[email protected]>
Date: Wed, 22 Oct 2025 11:36:13 +0200
Subject: [PATCH v1] docs: Link to the correct protocol version inspection
 function

The docs for max_protocol_version suggested PQprotocolVersion instead of
PQfullProtocolVersion to find out the exact protocol version. Since
PQprotocolVersion only returns the major protocol version that is bad
advice.

Author: Jelte Fennema-Nio <[email protected]>
Backpatch-through: 18
---
 doc/src/sgml/libpq.sgml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 5bf59a19855..e76da383714 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -2220,7 +2220,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
         server does not support the protocol version requested by the client,
         the connection is automatically downgraded to a lower minor protocol
         version that the server supports. After the connection attempt has
-        completed you can use <xref linkend="libpq-PQprotocolVersion"/> to
+        completed you can use <xref linkend="libpq-PQfullProtocolVersion"/> to
         find out which exact protocol version was negotiated.
        </para>
 

base-commit: 2d7b247cb414ccbc052c485fd82a841477a7e1ff
-- 
2.51.1



reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: docs: Link to the correct protocol version inspection function
  In-Reply-To: <CAGECzQSKFxQsYAgr11PhdOr-RtPZEdAXZnHx6U3avLuk3xQaTQ@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox