Reorder min/max_protocol_version descriptions in libpq documentation

Started by Fujii Masao11 months ago3 messagesdocs
Jump to latest
#1Fujii Masao
masao.fujii@gmail.com

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

Attachments:

v1-0001-doc-Reorder-protocol-version-option-descriptions-.patchtext/plain; charset=UTF-8; name=v1-0001-doc-Reorder-protocol-version-option-descriptions-.patchDownload+18-19
#2Jelte Fennema-Nio
postgres@jeltef.nl
In reply to: Fujii Masao (#1)
Re: Reorder min/max_protocol_version descriptions in libpq documentation

On Tue, 17 Jun 2025 at 18:32, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:

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?

Not that I can remember, probably because I copied the
ssl_min_protocol_version section when writing the initial version
min_protocol_version section.

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.

+1

#3Fujii Masao
masao.fujii@gmail.com
In reply to: Jelte Fennema-Nio (#2)
Re: Reorder min/max_protocol_version descriptions in libpq documentation

On 2025/06/18 1:34, Jelte Fennema-Nio wrote:

On Tue, 17 Jun 2025 at 18:32, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:

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?

Not that I can remember, probably because I copied the
ssl_min_protocol_version section when writing the initial version
min_protocol_version section.

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.

+1

I've pushed the patch. Thanks!

Regards,

--
Fujii Masao
NTT DATA Japan Corporation