Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit e29df42

Browse files
committed
doc: Mention naming convention used by injection points
All the injection points used in the tree have relied on an implied rule: their names should be made of lower-case characters, with dashes between the words used. This commit adds a light mention about that in the docs, encouraging the practice. Author: Hayato Kuroda <kuroda.hayato@fujitsu.com> Reviewed-by: Aleksander Alekseev <aleksander@timescale.com> Discussion: https://postgr.es/m/OSCPR01MB14966E14C1378DEE51FB7B7C5F5B32@OSCPR01MB14966.jpnprd01.prod.outlook.com Backpatch-through: 17
1 parent 0b06459 commit e29df42

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/src/sgml/xfunc.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3836,7 +3836,8 @@ INJECTION_POINT(name);
38363836
within the server code. After adding a new injection point the code needs
38373837
to be compiled in order for that injection point to be available in the
38383838
binary. Add-ins written in C-language can declare injection points in
3839-
their own code using the same macro.
3839+
their own code using the same macro. The injection point names should
3840+
use lower-case characters, with terms separated by dashes.
38403841
</para>
38413842

38423843
<para>

0 commit comments

Comments
 (0)