pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedconfusing positioning of notes in connection settings
11+ messages / 3 participants
[nested] [flat]
* confusing positioning of notes in connection settings
@ 2023-04-22 19:53 Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
0 siblings, 1 reply; 11+ messages in thread
From: Jonathan S. Katz @ 2023-04-22 19:53 UTC (permalink / raw)
To: Pg Docs <pgsql-docs@lists.postgresql.org>
While testing a few other things on the connection settings page[1], I
noticed the notes on the "tcp_*" family of settings. While scrolling
further down the page, I found myself slightly confused over which note
corresponded to which setting (example in screenshot).
Given the nature of these notes, i.e. to say that the setting is not
supported in Windows, couldn't we just add that text to the description
of the parameter and remove the note? I think that'd make it a bit
clearer which comment applies to which parameter.
While arguably this is not a big deal now, the new deep-linking work for
v16[2] could make this a bit more confusing.
Thoughts?
Thanks,
Jonathan
[1]
https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-TCP-KEEPALIVES-COUNT
[2]
https://www.postgresql.org/docs/devel/runtime-config-connection.html#GUC-TCP-KEEPALIVES-COUNT
Attachments:
[image/png] Screen Shot 2023-04-22 at 3.46.34 PM.png (119.7K, ../../6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org/2-Screen%20Shot%202023-04-22%20at%203.46.34%20PM.png)
download | view image
[application/pgp-signature] OpenPGP_signature (839B, ../../6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org/3-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
@ 2023-04-26 06:08 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 11+ messages in thread
From: Peter Eisentraut @ 2023-04-26 06:08 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; Pg Docs <pgsql-docs@lists.postgresql.org>
On 22.04.23 21:53, Jonathan S. Katz wrote:
> While testing a few other things on the connection settings page[1], I
> noticed the notes on the "tcp_*" family of settings. While scrolling
> further down the page, I found myself slightly confused over which note
> corresponded to which setting (example in screenshot).
>
> Given the nature of these notes, i.e. to say that the setting is not
> supported in Windows, couldn't we just add that text to the description
> of the parameter and remove the note? I think that'd make it a bit
> clearer which comment applies to which parameter.
I agree we could fold the notes (and other similar notes nearby) into
the main text. Or we could just remove them, because the main text
already contains the information in more general form.
I wonder if the notes are even true. The text for
tcp_keepalives_interval already says that it is only supported if
TCP_KEEPCNT is supported. There is no specific code for Windows.
Random googling suggests that TCP_KEEPCNT does exist on Windows.
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
@ 2023-04-26 08:18 ` Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 11+ messages in thread
From: Daniel Gustafsson @ 2023-04-26 08:18 UTC (permalink / raw)
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>; +Cc: Jonathan S. Katz <jkatz@postgresql.org>; Pg Docs <pgsql-docs@lists.postgresql.org>
> On 26 Apr 2023, at 08:08, Peter Eisentraut <peter.eisentraut@enterprisedb.com> wrote:
> I wonder if the notes are even true. The text for tcp_keepalives_interval already says that it is only supported if TCP_KEEPCNT is supported.
Don't forget the "and on Windows;" part.
> There is no specific code for Windows.
We have pq_setkeepaliveswin32() for Windows which can work on Windows 2000 and
later versions based on the existence of SIO_KEEPALIVE_VALS.
> Random googling suggests that TCP_KEEPCNT does exist on Windows.
For Windows what you want is SIO_KEEPALIVE_VALS.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
@ 2023-04-26 11:36 ` Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
0 siblings, 1 reply; 11+ messages in thread
From: Daniel Gustafsson @ 2023-04-26 11:36 UTC (permalink / raw)
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>; +Cc: Jonathan S. Katz <jkatz@postgresql.org>; Pg Docs <pgsql-docs@lists.postgresql.org>
> On 26 Apr 2023, at 10:18, Daniel Gustafsson <daniel@yesql.se> wrote:
>
>> On 26 Apr 2023, at 08:08, Peter Eisentraut <peter.eisentraut@enterprisedb.com> wrote:
>
>> I wonder if the notes are even true. The text for tcp_keepalives_interval already says that it is only supported if TCP_KEEPCNT is supported.
Re-reading this I think there was some confusion, definitely so on my part.
tcp_keepalives_interval relies on TCP_KEEPINTVL, with the Windows equivalent
being SIO_KEEPALIVE_VALS. TCP_KEEPCNT is for tcp_keepalives_count which indeed
is not supported on Windows. Jonathans original question was regarding _count
and _timeout and not _interval.
I do agree that all of these notes may just as well be added to the text, the
option client_connection_check_interval following these have text about
platform compatibility without using a note.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
@ 2023-05-31 11:16 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 11+ messages in thread
From: Peter Eisentraut @ 2023-05-31 11:16 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Jonathan S. Katz <jkatz@postgresql.org>; Pg Docs <pgsql-docs@lists.postgresql.org>
On 26.04.23 07:36, Daniel Gustafsson wrote:
>> On 26 Apr 2023, at 10:18, Daniel Gustafsson <daniel@yesql.se> wrote:
>>
>>> On 26 Apr 2023, at 08:08, Peter Eisentraut <peter.eisentraut@enterprisedb.com> wrote:
>>
>>> I wonder if the notes are even true. The text for tcp_keepalives_interval already says that it is only supported if TCP_KEEPCNT is supported.
>
> Re-reading this I think there was some confusion, definitely so on my part.
>
> tcp_keepalives_interval relies on TCP_KEEPINTVL, with the Windows equivalent
> being SIO_KEEPALIVE_VALS. TCP_KEEPCNT is for tcp_keepalives_count which indeed
> is not supported on Windows. Jonathans original question was regarding _count
> and _timeout and not _interval.
>
> I do agree that all of these notes may just as well be added to the text, the
> option client_connection_check_interval following these have text about
> platform compatibility without using a note.
How about this patch?
The first two hunks are pretty straightforward, they just move the
existing text around.
For the other two, which are not supported on Windows, I added an
explicit parenthetical note. We don't list which of the Unix-like
platforms support the respective options, but I suspect that it's all of
them in practice? (Otherwise we should be more explicit.) So I think
calling out Windows explicitly is sensible, also considering that the
first two settings are supported on Windows but the latter two are not.
From 97fe489263f18314e99ec471ab160dbc026a1841 Mon Sep 17 00:00:00 2001
From: Peter Eisentraut <peter@eisentraut.org>
Date: Wed, 31 May 2023 07:12:38 -0400
Subject: [PATCH] doc: Fix confusing positioning of notes in connection
settings
Discussion: https://www.postgresql.org/message-id/flat/6f825d42-a1ce-492a-2ea7-c83e6e65fa8b%40postgresql.org
---
doc/src/sgml/config.sgml | 30 ++++++------------------------
1 file changed, 6 insertions(+), 24 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 5da74b3c40..5873a0ef2f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -950,18 +950,14 @@ <title>TCP Settings</title>
the operating system should send a TCP keepalive message to the client.
If this value is specified without units, it is taken as seconds.
A value of 0 (the default) selects the operating system's default.
+ On Windows, setting a value of 0 will set this parameter to 2 hours,
+ since Windows does not provide a way to read the system default value.
This parameter is supported only on systems that support
<symbol>TCP_KEEPIDLE</symbol> or an equivalent socket option, and on
Windows; on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- On Windows, setting a value of 0 will set this parameter to 2 hours,
- since Windows does not provide a way to read the system default value.
- </para>
- </note>
</listitem>
</varlistentry>
@@ -977,18 +973,14 @@ <title>TCP Settings</title>
that has not been acknowledged by the client should be retransmitted.
If this value is specified without units, it is taken as seconds.
A value of 0 (the default) selects the operating system's default.
+ On Windows, setting a value of 0 will set this parameter to 1 second,
+ since Windows does not provide a way to read the system default value.
This parameter is supported only on systems that support
<symbol>TCP_KEEPINTVL</symbol> or an equivalent socket option, and on
Windows; on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- On Windows, setting a value of 0 will set this parameter to 1 second,
- since Windows does not provide a way to read the system default value.
- </para>
- </note>
</listitem>
</varlistentry>
@@ -1004,16 +996,11 @@ <title>TCP Settings</title>
the server's connection to the client is considered dead.
A value of 0 (the default) selects the operating system's default.
This parameter is supported only on systems that support
- <symbol>TCP_KEEPCNT</symbol> or an equivalent socket option;
+ <symbol>TCP_KEEPCNT</symbol> or an equivalent socket option (which does not include Windows);
on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- This parameter is not supported on Windows, and must be zero.
- </para>
- </note>
</listitem>
</varlistentry>
@@ -1030,15 +1017,10 @@ <title>TCP Settings</title>
If this value is specified without units, it is taken as milliseconds.
A value of 0 (the default) selects the operating system's default.
This parameter is supported only on systems that support
- <symbol>TCP_USER_TIMEOUT</symbol>; on other systems, it must be zero.
+ <symbol>TCP_USER_TIMEOUT</symbol> (which does not include Windows); on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- This parameter is not supported on Windows, and must be zero.
- </para>
- </note>
</listitem>
</varlistentry>
--
2.40.1
Attachments:
[text/plain] 0001-doc-Fix-confusing-positioning-of-notes-in-connection.patch (4.2K, ../../ab7511ea-a089-2445-f64d-0bf72ebb7bc4@enterprisedb.com/2-0001-doc-Fix-confusing-positioning-of-notes-in-connection.patch)
download | inline diff:
From 97fe489263f18314e99ec471ab160dbc026a1841 Mon Sep 17 00:00:00 2001
From: Peter Eisentraut <peter@eisentraut.org>
Date: Wed, 31 May 2023 07:12:38 -0400
Subject: [PATCH] doc: Fix confusing positioning of notes in connection
settings
Discussion: https://www.postgresql.org/message-id/flat/6f825d42-a1ce-492a-2ea7-c83e6e65fa8b%40postgresql.org
---
doc/src/sgml/config.sgml | 30 ++++++------------------------
1 file changed, 6 insertions(+), 24 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 5da74b3c40..5873a0ef2f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -950,18 +950,14 @@ <title>TCP Settings</title>
the operating system should send a TCP keepalive message to the client.
If this value is specified without units, it is taken as seconds.
A value of 0 (the default) selects the operating system's default.
+ On Windows, setting a value of 0 will set this parameter to 2 hours,
+ since Windows does not provide a way to read the system default value.
This parameter is supported only on systems that support
<symbol>TCP_KEEPIDLE</symbol> or an equivalent socket option, and on
Windows; on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- On Windows, setting a value of 0 will set this parameter to 2 hours,
- since Windows does not provide a way to read the system default value.
- </para>
- </note>
</listitem>
</varlistentry>
@@ -977,18 +973,14 @@ <title>TCP Settings</title>
that has not been acknowledged by the client should be retransmitted.
If this value is specified without units, it is taken as seconds.
A value of 0 (the default) selects the operating system's default.
+ On Windows, setting a value of 0 will set this parameter to 1 second,
+ since Windows does not provide a way to read the system default value.
This parameter is supported only on systems that support
<symbol>TCP_KEEPINTVL</symbol> or an equivalent socket option, and on
Windows; on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- On Windows, setting a value of 0 will set this parameter to 1 second,
- since Windows does not provide a way to read the system default value.
- </para>
- </note>
</listitem>
</varlistentry>
@@ -1004,16 +996,11 @@ <title>TCP Settings</title>
the server's connection to the client is considered dead.
A value of 0 (the default) selects the operating system's default.
This parameter is supported only on systems that support
- <symbol>TCP_KEEPCNT</symbol> or an equivalent socket option;
+ <symbol>TCP_KEEPCNT</symbol> or an equivalent socket option (which does not include Windows);
on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- This parameter is not supported on Windows, and must be zero.
- </para>
- </note>
</listitem>
</varlistentry>
@@ -1030,15 +1017,10 @@ <title>TCP Settings</title>
If this value is specified without units, it is taken as milliseconds.
A value of 0 (the default) selects the operating system's default.
This parameter is supported only on systems that support
- <symbol>TCP_USER_TIMEOUT</symbol>; on other systems, it must be zero.
+ <symbol>TCP_USER_TIMEOUT</symbol> (which does not include Windows); on other systems, it must be zero.
In sessions connected via a Unix-domain socket, this parameter is
ignored and always reads as zero.
</para>
- <note>
- <para>
- This parameter is not supported on Windows, and must be zero.
- </para>
- </note>
</listitem>
</varlistentry>
--
2.40.1
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
@ 2023-05-31 11:53 ` Daniel Gustafsson <daniel@yesql.se>
2023-06-05 17:10 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 1 reply; 11+ messages in thread
From: Daniel Gustafsson @ 2023-05-31 11:53 UTC (permalink / raw)
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>; +Cc: Jonathan S. Katz <jkatz@postgresql.org>; Pg Docs <pgsql-docs@lists.postgresql.org>
> On 31 May 2023, at 13:16, Peter Eisentraut <peter.eisentraut@enterprisedb.com> wrote:
> The first two hunks are pretty straightforward, they just move the existing text around.
>
> For the other two, which are not supported on Windows, I added an explicit parenthetical note. We don't list which of the Unix-like platforms support the respective options, but I suspect that it's all of them in practice? (Otherwise we should be more explicit.) So I think calling out Windows explicitly is sensible, also considering that the first two settings are supported on Windows but the latter two are not.
I think this is a clear improvement over the current docs.
Should we call out Windows explicitly in the same way in the corresponding
options in the libpq connection string param docs as well?
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
@ 2023-06-05 17:10 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-06-06 07:56 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-06-07 15:17 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
0 siblings, 2 replies; 11+ messages in thread
From: Jonathan S. Katz @ 2023-06-05 17:10 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; Peter Eisentraut <peter.eisentraut@enterprisedb.com>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
On 5/31/23 7:53 AM, Daniel Gustafsson wrote:
>> On 31 May 2023, at 13:16, Peter Eisentraut <peter.eisentraut@enterprisedb.com> wrote:
>
>> The first two hunks are pretty straightforward, they just move the existing text around.
>>
>> For the other two, which are not supported on Windows, I added an explicit parenthetical note. We don't list which of the Unix-like platforms support the respective options, but I suspect that it's all of them in practice? (Otherwise we should be more explicit.) So I think calling out Windows explicitly is sensible, also considering that the first two settings are supported on Windows but the latter two are not.
>
> I think this is a clear improvement over the current docs.
+1.
Small nit:
"which does not include Windows" =>
"which is not supported on Windows"
(in two places)
> Should we call out Windows explicitly in the same way in the corresponding
> options in the libpq connection string param docs as well?
Probably, but I see language like this:
"It is only supported on systems where TCP_USER_TIMEOUT is available; on
other systems, it has no effect."
If this is really only unsupported / has different settings on Windows,
I think it's OK to call that out. The original gripe was about
readability, but if we think the description in the other settings is no
clear enough, we can edit it.
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../739043ea-9fe8-3fa5-ed10-aa988eaeb121@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-06-05 17:10 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
@ 2023-06-06 07:56 ` Daniel Gustafsson <daniel@yesql.se>
1 sibling, 0 replies; 11+ messages in thread
From: Daniel Gustafsson @ 2023-06-06 07:56 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; +Cc: Peter Eisentraut <peter.eisentraut@enterprisedb.com>; Pg Docs <pgsql-docs@lists.postgresql.org>
> On 5 Jun 2023, at 19:10, Jonathan S. Katz <jkatz@postgresql.org> wrote:
> "It is only supported on systems where TCP_USER_TIMEOUT is available; on other systems, it has no effect."
>
> If this is really only unsupported / has different settings on Windows, I think it's OK to call that out. The original gripe was about readability, but if we think the description in the other settings is no clear enough, we can edit it.
TCP_USER_TIMEOUT is not widely available, AFAIK FreeBSD, OpenBSD and macOS do
not support it yet.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-06-05 17:10 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
@ 2023-06-07 15:17 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-06-07 15:34 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
1 sibling, 1 reply; 11+ messages in thread
From: Peter Eisentraut @ 2023-06-07 15:17 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; Daniel Gustafsson <daniel@yesql.se>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
On 05.06.23 19:10, Jonathan S. Katz wrote:
> On 5/31/23 7:53 AM, Daniel Gustafsson wrote:
>>> On 31 May 2023, at 13:16, Peter Eisentraut
>>> <peter.eisentraut@enterprisedb.com> wrote:
>>
>>> The first two hunks are pretty straightforward, they just move the
>>> existing text around.
>>>
>>> For the other two, which are not supported on Windows, I added an
>>> explicit parenthetical note. We don't list which of the Unix-like
>>> platforms support the respective options, but I suspect that it's all
>>> of them in practice? (Otherwise we should be more explicit.) So I
>>> think calling out Windows explicitly is sensible, also considering
>>> that the first two settings are supported on Windows but the latter
>>> two are not.
>>
>> I think this is a clear improvement over the current docs.
>
> +1.
>
> Small nit:
>
> "which does not include Windows" =>
> "which is not supported on Windows"
>
> (in two places)
The proposed text in the patch is
"This parameter is supported only on systems that {have this property}
(which does not include Windows)."
I don't see how the change you are proposing is correct.
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-06-05 17:10 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-06-07 15:17 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
@ 2023-06-07 15:34 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-06-07 16:01 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
0 siblings, 1 reply; 11+ messages in thread
From: Jonathan S. Katz @ 2023-06-07 15:34 UTC (permalink / raw)
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>; Daniel Gustafsson <daniel@yesql.se>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
On 6/7/23 11:17 AM, Peter Eisentraut wrote:
> The proposed text in the patch is
>
> "This parameter is supported only on systems that {have this property}
> (which does not include Windows)."
>
> I don't see how the change you are proposing is correct.
I see -- I had read it quickly and didn't sound it out. Nit withdrawn.
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../8d88b78e-08d0-a703-4127-76023757efac@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: confusing positioning of notes in connection settings
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Re: confusing positioning of notes in connection settings Daniel Gustafsson <daniel@yesql.se>
2023-06-05 17:10 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-06-07 15:17 ` Re: confusing positioning of notes in connection settings Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-06-07 15:34 ` Re: confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
@ 2023-06-07 16:01 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
0 siblings, 0 replies; 11+ messages in thread
From: Peter Eisentraut @ 2023-06-07 16:01 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; Daniel Gustafsson <daniel@yesql.se>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
On 07.06.23 17:34, Jonathan S. Katz wrote:
> On 6/7/23 11:17 AM, Peter Eisentraut wrote:
>
>> The proposed text in the patch is
>>
>> "This parameter is supported only on systems that {have this property}
>> (which does not include Windows)."
>>
>> I don't see how the change you are proposing is correct.
>
> I see -- I had read it quickly and didn't sound it out. Nit withdrawn.
Ok, I committed it.
I don't have an opinion on whether any changes are necessary on the
libpq side.
^ permalink raw reply [nested|flat] 11+ messages in thread
end of thread, other threads:[~2023-06-07 16:01 UTC | newest]
Thread overview: 11+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-04-22 19:53 confusing positioning of notes in connection settings Jonathan S. Katz <jkatz@postgresql.org>
2023-04-26 06:08 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-04-26 08:18 ` Daniel Gustafsson <daniel@yesql.se>
2023-04-26 11:36 ` Daniel Gustafsson <daniel@yesql.se>
2023-05-31 11:16 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-05-31 11:53 ` Daniel Gustafsson <daniel@yesql.se>
2023-06-05 17:10 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-06-06 07:56 ` Daniel Gustafsson <daniel@yesql.se>
2023-06-07 15:17 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
2023-06-07 15:34 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-06-07 16:01 ` Peter Eisentraut <peter.eisentraut@enterprisedb.com>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox