]> Gentwo Git Trees - linux/.git/commitdiff
doc-guide: kernel-doc: add %CONST examples
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 4 Nov 2025 05:09:30 +0000 (21:09 -0800)
committerJonathan Corbet <corbet@lwn.net>
Wed, 5 Nov 2025 18:27:12 +0000 (11:27 -0700)
Add examples of using '%' for formatting constant values to
facilitate more usage of "%CONST" in kernel-doc.

Suggested-by: Tony Luck <tony.luck@intel.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251104050930.720711-1-rdunlap@infradead.org>

Documentation/doc-guide/kernel-doc.rst

index 4370cc8fbcf5e5972befbcb4d36322a0dc456dd3..fd89a6d56ea9afbedc9ae1513219e94cb496bbd8 100644 (file)
@@ -405,6 +405,10 @@ Domain`_ references.
 ``%CONST``
   Name of a constant. (No cross-referencing, just formatting.)
 
+  Examples::
+
+    %0    %NULL    %-1    %-EFAULT    %-EINVAL    %-ENOMEM
+
 ````literal````
   A literal block that should be handled as-is. The output will use a
   ``monospaced font``.