Re: Autogenerate some wait events code and documentation - Mailing list pgsql-hackers

From Michael Paquier
Subject Re: Autogenerate some wait events code and documentation
Date
Msg-id ZEX0QT6vROUONVRH@paquier.xyz
Whole thread Raw
In response to Re: Autogenerate some wait events code and documentation  ("Drouvot, Bertrand" <bertranddrouvot.pg@gmail.com>)
List pgsql-hackers
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?
>
> Yeah, that could be an option. V3 is still using the category as the first 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 = ("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 \
>>
>> Looks like a copy-pasto.
>
> 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

Attachment

pgsql-hackers by date:

Previous
From: Kyotaro Horiguchi
Date:
Subject: Re: Perform streaming logical transactions by background workers and parallel apply
Next
From: Amit Kapila
Date:
Subject: Re: Perform streaming logical transactions by background workers and parallel apply