1berry/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Mention naming convention used by injection points

Browse Source 
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
This commit is contained in:
Michael Paquier 2025-04-22 12:41:58 +09:00
parent f04b11454d
commit 185d345d79
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/src/sgml/xfunc.sgml
View File

@ -3615,7 +3615,8 @@ INJECTION_POINT(name);
within the server code. After adding a new injection point the code needs
to be compiled in order for that injection point to be available in the
binary. Add-ins written in C-language can declare injection points in
their own code using the same macro.
their own code using the same macro. The injection point names should
use lower-case characters, with terms separated by dashes.
</para>
<para>