Skip to content

Commit 428a876

Browse files
committed
doc: Reorder protocol version option descriptions in libpq docs.
Commit 285613c 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. Author: Fujii Masao <masao.fujii@gmail.com> Reviewed-by: Jelte Fennema-Nio <postgres@jeltef.nl> Discussion: https://postgr.es/m/a3391f36-30f5-4d4a-825b-232476819de8@oss.nttdata.com
1 parent bb43c97 commit 428a876

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

doc/src/sgml/libpq.sgml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2168,6 +2168,24 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
21682168
</listitem>
21692169
</varlistentry>
21702170

2171+
<varlistentry id="libpq-connect-ssl-max-protocol-version" xreflabel="ssl_max_protocol_version">
2172+
<term><literal>ssl_max_protocol_version</literal></term>
2173+
<listitem>
2174+
<para>
2175+
This parameter specifies the maximum SSL/TLS protocol version to allow
2176+
for the connection. Valid values are <literal>TLSv1</literal>,
2177+
<literal>TLSv1.1</literal>, <literal>TLSv1.2</literal> and
2178+
<literal>TLSv1.3</literal>. The supported protocols depend on the
2179+
version of <productname>OpenSSL</productname> used, older versions
2180+
not supporting the most modern protocol versions. If not set, this
2181+
parameter is ignored and the connection will use the maximum bound
2182+
defined by the backend, if set. Setting the maximum protocol version
2183+
is mainly useful for testing or if some component has issues working
2184+
with a newer protocol.
2185+
</para>
2186+
</listitem>
2187+
</varlistentry>
2188+
21712189
<varlistentry id="libpq-connect-min-protocol-version" xreflabel="min_protocol_version">
21722190
<term><literal>min_protocol_version</literal></term>
21732191
<listitem>
@@ -2216,24 +2234,6 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
22162234
</listitem>
22172235
</varlistentry>
22182236

2219-
<varlistentry id="libpq-connect-ssl-max-protocol-version" xreflabel="ssl_max_protocol_version">
2220-
<term><literal>ssl_max_protocol_version</literal></term>
2221-
<listitem>
2222-
<para>
2223-
This parameter specifies the maximum SSL/TLS protocol version to allow
2224-
for the connection. Valid values are <literal>TLSv1</literal>,
2225-
<literal>TLSv1.1</literal>, <literal>TLSv1.2</literal> and
2226-
<literal>TLSv1.3</literal>. The supported protocols depend on the
2227-
version of <productname>OpenSSL</productname> used, older versions
2228-
not supporting the most modern protocol versions. If not set, this
2229-
parameter is ignored and the connection will use the maximum bound
2230-
defined by the backend, if set. Setting the maximum protocol version
2231-
is mainly useful for testing or if some component has issues working
2232-
with a newer protocol.
2233-
</para>
2234-
</listitem>
2235-
</varlistentry>
2236-
22372237
<varlistentry id="libpq-connect-krbsrvname" xreflabel="krbsrvname">
22382238
<term><literal>krbsrvname</literal></term>
22392239
<listitem>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy