From: Jonathan S. Katz <jkatz@postgresql.org>
To: David G. Johnston <david.g.johnston@gmail.com>
To: splarv@ya.ru
To: pgsql-docs@lists.postgresql.org
Subject: Re: 'value' has special behaviour in alter system
Date: Thu, 15 Dec 2022 11:50:33 -0500
Message-ID: <f601ac59-16f9-0b75-2831-e212bae7fda5@postgresql.org> (raw)
In-Reply-To: <CAKFQuwbefvj25vYz-0KJ-62oCg8-BxAd3PButBZTJ-7PzUcGbQ@mail.gmail.com>
References: <167105927893.1897.13227723035830709578@wrigleys.postgresql.org>
<CAKFQuwbefvj25vYz-0KJ-62oCg8-BxAd3PButBZTJ-7PzUcGbQ@mail.gmail.com>
On 12/15/22 10:50 AM, David G. Johnston wrote:
> On Thu, Dec 15, 2022 at 4:45 AM PG Doc comments form
> <noreply@postgresql.org <mailto:noreply@postgresql.org>> wrote:
>
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/15/sql-altersystem.html
> <https://www.postgresql.org/docs/15/sql-altersystem.html;
> Description:
>
> Documentation say
> ALTER SYSTEM SET configuration_parameter { TO | = } { value | 'value' |
> DEFAULT }
>
> The variant 'value' has special, not obvious behaviour and must be
> documented.
>
>
> This syntax representation and accompanying text annoys me too. It is
> logical behavior and described accurately, but I think readability could
> be improved.
>
> I suggest changing it to:
>
> SET configuration_parameter { TO | = } { value [, ...] | DEFAULT }
>
> Values can be specified as unquoted alphanumeric+underscore sequences.
> If the value contains any non-alphanumeric (plus underscore) characters
> it should be enclosed in quotes (single or double, it does not matter).
> For settings that accept multiple values, separate each value to be
> supplied with a comma (and optional whitespace).
+1 in general. I would also suggest we add an example in the Examples
section to show what the output is when you add single-quotes.
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../f601ac59-16f9-0b75-2831-e212bae7fda5@postgresql.org/2-OpenPGP_signature)
download
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: jkatz@postgresql.org, david.g.johnston@gmail.com, splarv@ya.ru, pgsql-docs@lists.postgresql.org
Subject: Re: 'value' has special behaviour in alter system
In-Reply-To: <f601ac59-16f9-0b75-2831-e212bae7fda5@postgresql.org>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
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