Feedback-ID: i0fe9450f:Fastmail
Date: Fri, 24 Nov 2023 12:11:19 +0900
From: Michael Paquier <michael@paquier.xyz>
To: Peter Smith <smithpb2250@gmail.com>
Cc: Alvaro Herrera <alvherre@alvh.no-ip.org>,
	Nathan Bossart <nathandbossart@gmail.com>,
	Laurenz Albe <laurenz.albe@cybertec.at>,
	Peter Eisentraut <peter@eisentraut.org>,
	Tom Lane <tgl@sss.pgh.pa.us>, Daniel Gustafsson <daniel@yesql.se>,
	PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Subject: Re: GUC names in messages
Message-ID: <ZWAUV4fdjFw5nWvj@paquier.xyz>
References: <CAHut+PtqTao+OKRxGcCzUxt9h9d0=TQZZoRjMYe3xe0-O7_hsQ@mail.gmail.com>
 <202311091104.l57bnizku723@alvherre.pgsql>
 <CAHut+PsXEqjxdvR6sZX6ihgWhK8jwk=L7VJdAJJT+hwAVwwj7w@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="q64KTkecDBeibPs3"
Content-Disposition: inline
In-Reply-To: <CAHut+PsXEqjxdvR6sZX6ihgWhK8jwk=L7VJdAJJT+hwAVwwj7w@mail.gmail.com>
Archived-At: <https://www.postgresql.org/message-id/ZWAUV4fdjFw5nWvj%40paquier.xyz>
Precedence: bulk


--q64KTkecDBeibPs3
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Thu, Nov 23, 2023 at 06:27:04PM +1100, Peter Smith wrote:
> There may be some changes I've missed, but hopefully, this is a nudge
> in the right direction.

Thanks for spending some time on that.

    <para>
+    In messages containing configuration variable names, do not include quotes
+    when the names are visibly not English natural words, such as when they
+    have underscores or are all-uppercase or have mixed case. Otherwise, quotes
+    must be added.  Do include quotes in a message where an arbitrary variable
+    name is to be expanded.
+   </para>

That seems to describe clearly the consensus reached on the thread
(quotes for GUCs that are single terms, no quotes for names that are
obviously parameters).

In terms of messages that have predictible names, 0002 moves in the
needle in the right direction.  There seem to be more:
src/backend/postmaster/bgworker.c:  errhint("Consider increasing the
configuration parameter \"max_worker_processes\".")));
contrib/pg_prewarm/autoprewarm.c:  errhint("Consider increasing
configuration parameter \"max_worker_processes\".")));

Things like parse_and_validate_value() and set_config_option_ext()
include log strings about GUC and these use quotes.  Could these areas
be made smarter with a routine to check if quotes are applied
automatically when we have a "simple" GUC name, aka I guess made of
only lower-case characters?  This could be done with a islower() on
the string name, for instance.
--
Michael

--q64KTkecDBeibPs3
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAmVgFFcACgkQnvQgOdby
QH21ehAAkg3flJAmdq/Dww6llPINYYEvS6PfvL5OXrSx6qiMX0B0OGiwTdYnnu/F
gSMl9MaW+22PrBMRPJH99Evd7b3dap8kkY5+fU6XwD7rPOALADrjcqH7uMh9uWbI
aKC5WesaBWe7/Ad7oj4LMWWqrI2E2kdEPWwUqqB8c4WjcN/t9GX15ZPQXBre+g0K
NftTtTP2taPXvEvVfVjdxiqgYF+/D84SGFSmFYtaDHl6y8ChBSi4tP4o4VxVoUJ5
SKztzfOUTWyuJXjYejx9xhk2v3fMezWDzstAe2GeuyBz/AuvQ7a82WiC/ofwvrfp
a7jFsgIB1aQCoZ3kSEuSaTZE9kdFax0UEAekWzCUtEUiDFG5svpd7ofrHmgMaMSh
q13IEEK6Z0BqI/wiI4kAG+JoJl2MG0mF/CjtDJ/f1LaO0V8zct6iIA0BrQ7n7h1/
LY0dS3BoPW+3tCv7fKYRHcsn4RJ9Smz+4UOkjrj7OSqMxiCMjOFD98SQNcTwlxLq
MB83obNDtgKLSa+XyldiNgVTJ+TVmLFXYBo17kK2sLTzNgvzjRj0kr4UJCVYagKl
4NmtUy3lNr0qXZiGq8QuGWrEmG0sRnvR+jbb6Cy5Jxw+Z7Y4oTsMOnLEkBbuTbjs
9qVd3lz8yHhR9N8MJhpM0zINFP1qMGlMXrPIgw404lh+b+7F5lg=
=tSF/
-----END PGP SIGNATURE-----

--q64KTkecDBeibPs3--