v3-0001-Doc-clarify-the-naming-rule-for-injection-points.patch

application/octet-stream

Filename: v3-0001-Doc-clarify-the-naming-rule-for-injection-points.patch
Type: application/octet-stream
Part: 0
Message: RE: doc patch: clarify the naming rule for injection_points

Patch

Format: format-patch
Series: patch v3-0001
Subject: Doc: clarify the naming rule for injection points
File+
doc/src/sgml/xfunc.sgml 2 1
From 25954dbd739b1e92e8d959b2fe1ff60c3bedd584 Mon Sep 17 00:00:00 2001
From: Hayato Kuroda <kuroda.hayato@fujitsu.com>
Date: Mon, 14 Apr 2025 20:00:13 +0900
Subject: [PATCH v3 1/2] Doc: clarify the naming rule for injection points

---
 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 8074f66417d..c0726331d62 100644
--- a/doc/src/sgml/xfunc.sgml
+++ b/doc/src/sgml/xfunc.sgml
@@ -3836,7 +3836,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.  By convention, the name of injection
+     points is lower characters, and dashes separate its terms.
     </para>
 
     <para>
-- 
2.43.5