Feedback-ID: i0fe9450f:Fastmail
Date: Mon, 24 Apr 2023 12:15:13 +0900
From: Michael Paquier <michael@paquier.xyz>
To: "Drouvot, Bertrand" <bertranddrouvot.pg@gmail.com>
Cc: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Subject: Re: Autogenerate some wait events code and documentation
Message-ID: <ZEX0QT6vROUONVRH@paquier.xyz>
References: <77a86b3a-c4a8-5f5d-69b9-d70bbf2e9b98@gmail.com>
 <6b6cdc76-e10e-95f8-62cf-3a3137c86df5@gmail.com>
 <ZECQvY2tt6p+ZHiX@paquier.xyz>
 <2e649ed7-6c66-5d6a-16d4-5d5367d40e69@gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="QBWZEYKofo64Qnan"
Content-Disposition: inline
In-Reply-To: <2e649ed7-6c66-5d6a-16d4-5d5367d40e69@gmail.com>
Archived-At: 
 <https://www.postgresql.org/message-id/ZEX0QT6vROUONVRH%40paquier.xyz>
Precedence: bulk


--QBWZEYKofo64Qnan
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Sat, Apr 22, 2023 at 03:36:05PM +0200, Drouvot, Bertrand wrote:
> On 4/20/23 3:09 AM, Michael Paquier wrote:
>> It is clear that the format of the file is:
>> - category
>> - C symbol in enums.
>> - Format in the system views.
>> - Description in the docs.
>> Or perhaps it would be better to divide this file by sections (like
>> errcodes.txt) for each category so as we eliminate entirely the first
>> column?
>=20
> Yeah, that could be an option. V3 is still using the category as the firs=
t column
> but I'm ok to change it by a section if you prefer (though I don't really=
 see the need).

It can make the file width shorter, at least..

[ .. thinks .. ]

+my $waitclass;
+my @wait_classes =3D ("PG_WAIT_ACTIVITY", "PG_WAIT_CLIENT", "PG_WAIT_IPC",=
 "PG_WAIT_TIMEOUT", "PG_WAIT_IO");

Actually, having a "Section" in waiteventnames.txt would remove the
need to store this knowledge in generate-waiteventnames.pl, which is
a duplicate of the txt contents.  If somebody adds a new class in the
future, it would be necessary to update this path as well.  Well, that
would not be a huge effort in itself, but IMO the script translating
the .txt to the docs and the code should have no need to know the
types of classes.  I guess that a format like that would make the most
sense to me, then:
Section: ClassName PG_WAIT_CLASS_NAME

# ClassName would be "IO", "IPC", "Timeout", etc.

WAIT_EVENT_NAME_1 "WaitEventName1" "Description of wait event 1"
WAIT_EVENT_NAME_N "WaitEventNameN" "Description of wait event N"

>>            utils/adt/jsonpath_scan.c \
>> +         utils/activity/waiteventnames.c \
>> +         utils/activity/waiteventnames.h \
>> +         utils/adt/jsonpath_scan.c \
>>=20
>> Looks like a copy-pasto.
>=20
> Why do you think so? both files have to be removed.

jsonpath_scan.c is listed twice, and that's still the case in v3.  The
list of files deleted for maintainer-clean in src/backend/Makefile
should be listed alphabetically (utils/activity/ before utils/adt/),
but that's a nit ;)
--
Michael

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

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

iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAmRF9EEACgkQnvQgOdby
QH2K8BAAmDKiLTe/ScbfUW8AVAfxOcDNqB0ozp3vqFPiCtYY0RRHZ5ecGr3PirwN
M6k2mOmXV2SCVBDFMA2Su4qSZ226lBGF2Xy2UQVY4aSpAmsqF0KEePhF6U6SBkpB
JS1OJyc7fjXp0Ksec7o+GYpMd/hLJfGDrt/gZQcthTMexss99FXH5q2N73GxPdNh
Rs7OT5UUrhbtzjaSwo628sLNh+I5LxEpcmZkg6EJEkQfOFFtfi/9305MdO+wEhEU
/N5S7OIFvAeKJ+bUnJE6QVNrQS05J/P811oEJ/UinNKkOLNVxjbMJ753gJH7PZT5
Ao9MJ1TWuKWWdvm7uX7BLRbVZVpIHqBbKHWurzZbiUdds14dGidMhCkIYCl7SHZj
K2LDtQ6uQNrXhhJOc3Jhbnje87v/Q05sNbiqohgAlJG//3S8w99xcLUm0v9NVWu+
7SMKFxxATPemESV8H+DVF0rEQOVKAgvEvW7QCuo77vR3GvXyaOcvd9QSThSfpWnh
ry1P26SDXwUz4LJvrWMiP2yH8cUXHghcI8vG4vPc7tF9HuWee7nDyCX1NLu58sO5
O8ci8cDOEf9jphruy700LGA0ZxTlJiJu3RjE+q4RJyXOt4UyRuIvfmKeheatmKQe
vEGp06hOemzWSUpthAeO7iWWI9sVW8xqbIJBsdzWvEiTo8tksKA=
=yHvs
-----END PGP SIGNATURE-----

--QBWZEYKofo64Qnan--