Re: doc patch: clarify the naming rule for injection_points
Aleksander Alekseev <aleksander@timescale.com>
From: Aleksander Alekseev <aleksander@timescale.com>
To: "pgsql-hackers@lists.postgresql.org" <pgsql-hackers@lists.postgresql.org>
Cc: "Hayato Kuroda (Fujitsu)" <kuroda.hayato@fujitsu.com>
Date: 2025-04-14T11:51:24Z
Lists: pgsql-hackers
Hi, > Naming rule of points is not determined yet, but most of them have lower cases > and each term are divided by dash "-". I think this is a good chance to formally > clarify it. PSA adding the description. > > I was confused the correct place for the description. I added at the end of first > paragraph, because it describes how we add and use it. Suggestions are very > welcomed. ``` - 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 ... """ 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. 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. -- Best regards, Aleksander Alekseev
Commits
-
doc: Mention naming convention used by injection points
- 185d345d7909 17.5 landed
- e29df428a1dc 18.0 landed
-
Rename injection point for invalidation messages at end of transaction
- 21a9b2b086fa 17.5 landed
- 02c63f9438e0 18.0 landed