postgres.git / summary / log / commit / refs

commit    185d345d79095d705f02b3e1eb9fd0a06a144573
Author:   Michael Paquier <michael@paquier.xyz>
Date:     Tue Apr 22 03:41:58 2025 +0000
First released in: 18.0, 17.5

    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


 doc/src/sgml/xfunc.sgml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml
index f3a3e4e2f8f..a8aa871918a 100644
--- a/doc/src/sgml/xfunc.sgml
+++ b/doc/src/sgml/xfunc.sgml
@@ -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>


[parent: f04b11454d5d]