RE: doc patch: clarify the naming rule for injection_points

From: "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com>
To: 'Aleksander Alekseev' <aleksander(at)timescale(dot)com>
Cc: "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: RE: doc patch: clarify the naming rule for injection_points
Date: 2025-04-14 12:36:20
Message-ID: OSCPR01MB1496647920ABBAE650BA6760AF5B32@OSCPR01MB14966.jpnprd01.prod.outlook.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Dear Aleksander,

> ```
> - their own code using the same macro.
> + their own code using the same macro. The name of injection points must
> be
> + lower characters, and dashes must separate its terms.
> ```
>
> Perhaps "must" is a too strong statement. I suggest something like:
>
> """
> By convention, the name of injection points ...
> """

It is always difficult for me to distinguish them, thanks for comments.
PSA updated.

>
> I have mixed feelings about the patch overall though. This would mean
> that we need to rename injection points like this:
>
> ``
> AtEOXact_Inval-with-transInvalInfo
> heap_update-before-pin
> ```
>
> Otherwise we would contradict our own documentation.

Thanks for telling these counterexamples. I grepped with "INJECTION_POINTS" and
"IS_INJECTION_POINT_ATTACHED", and no others are found.

> I don't mind heap-update-before-pin, but not 100% sure if:
>
> at-eo-xact-inval-with-trans-inval-info
>
> ... would be a better name than the current one.

I also feel just converting lower case is not good. The point seems to locate in
the end-of-transaction callback and it accepts invalidation messages. Based on the
fact, how about "inval-process-invalidation-messages"?
0002 did simple replacements of these words.

Best regards,
Hayato Kuroda
FUJITSU LIMITED

Attachment Content-Type Size
v2-0002-Follow-naming-rules-for-injection-points.patch application/octet-stream 10.2 KB
v2-0001-Doc-clarify-the-naming-rule-for-injection-points.patch application/octet-stream 982 bytes

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Kirill Reshke 2025-04-14 12:39:02 Re: Add pg_get_injection_points() for information of injection points
Previous Message Michael Paquier 2025-04-14 12:32:29 Re: Add pg_get_injection_points() for information of injection points