RE: doc patch: clarify the naming rule for injection_points
Hayato Kuroda (Fujitsu) <kuroda.hayato@fujitsu.com>
From: "Hayato Kuroda (Fujitsu)" <kuroda.hayato@fujitsu.com>
To: 'Aleksander Alekseev' <aleksander@timescale.com>
Cc: "pgsql-hackers@lists.postgresql.org" <pgsql-hackers@lists.postgresql.org>
Date: 2025-04-14T12:36:20Z
Lists: pgsql-hackers
Attachments
- v2-0002-Follow-naming-rules-for-injection-points.patch (application/octet-stream) patch v2-0002
- v2-0001-Doc-clarify-the-naming-rule-for-injection-points.patch (application/octet-stream) patch v2-0001
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
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