Hi, Commit 285613c60a7 added the min_protocol_version and max_protocol_version connection options to libpq. However, their descriptions currently appear in the middle of the unrelated ssl_min_protocol_version and ssl_max_protocol_version entries in libpq.sgml. Is there a reason for this placement?
To make the documentation more intuitive and easier to navigate, I suggest moving these entries after the SSL-related options. Attached is a patch that does that. Thanks, -- Fujii Masao NTT DATA Japan Corporation
From de4ba3e771840024f07b5132baddeeb1dd611709 Mon Sep 17 00:00:00 2001 From: Fujii Masao <fu...@postgresql.org> Date: Wed, 18 Jun 2025 01:09:06 +0900 Subject: [PATCH v1] doc: Reorder protocol version option descriptions in libpq docs. Commit 285613c60a7 introduced the min_protocol_version and max_protocol_version connection options for libpq, but their descriptions were placed in the middle of the unrelated ssl_min_protocol_version and ssl_max_protocol_version entries. This commit moves the min_protocol_version and max_protocol_version descriptions to appear after the SSL-related options. This improves the logical order and makes it easier for users to locate the relevant settings in the libpq documentation. --- doc/src/sgml/libpq.sgml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 695fe958c3e..08bd5121926 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -2168,6 +2168,24 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname </listitem> </varlistentry> + <varlistentry id="libpq-connect-ssl-max-protocol-version" xreflabel="ssl_max_protocol_version"> + <term><literal>ssl_max_protocol_version</literal></term> + <listitem> + <para> + This parameter specifies the maximum SSL/TLS protocol version to allow + for the connection. Valid values are <literal>TLSv1</literal>, + <literal>TLSv1.1</literal>, <literal>TLSv1.2</literal> and + <literal>TLSv1.3</literal>. The supported protocols depend on the + version of <productname>OpenSSL</productname> used, older versions + not supporting the most modern protocol versions. If not set, this + parameter is ignored and the connection will use the maximum bound + defined by the backend, if set. Setting the maximum protocol version + is mainly useful for testing or if some component has issues working + with a newer protocol. + </para> + </listitem> + </varlistentry> + <varlistentry id="libpq-connect-min-protocol-version" xreflabel="min_protocol_version"> <term><literal>min_protocol_version</literal></term> <listitem> @@ -2216,24 +2234,6 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname </listitem> </varlistentry> - <varlistentry id="libpq-connect-ssl-max-protocol-version" xreflabel="ssl_max_protocol_version"> - <term><literal>ssl_max_protocol_version</literal></term> - <listitem> - <para> - This parameter specifies the maximum SSL/TLS protocol version to allow - for the connection. Valid values are <literal>TLSv1</literal>, - <literal>TLSv1.1</literal>, <literal>TLSv1.2</literal> and - <literal>TLSv1.3</literal>. The supported protocols depend on the - version of <productname>OpenSSL</productname> used, older versions - not supporting the most modern protocol versions. If not set, this - parameter is ignored and the connection will use the maximum bound - defined by the backend, if set. Setting the maximum protocol version - is mainly useful for testing or if some component has issues working - with a newer protocol. - </para> - </listitem> - </varlistentry> - <varlistentry id="libpq-connect-krbsrvname" xreflabel="krbsrvname"> <term><literal>krbsrvname</literal></term> <listitem> -- 2.49.0