Обсуждение: Reorder min/max_protocol_version descriptions in libpq documentation

Поиск
Список
Период
Сортировка

Reorder min/max_protocol_version descriptions in libpq documentation

От
Fujii Masao
Дата:
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

Вложения

Re: Reorder min/max_protocol_version descriptions in libpq documentation

От
Jelte Fennema-Nio
Дата:
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



Re: Reorder min/max_protocol_version descriptions in libpq documentation

От
Fujii Masao
Дата:

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