Skip to content

Commit dd3e817

Browse files
rddunlapJonathan Corbet
authored andcommitted
doc-guide: kernel-doc: add %CONST examples
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>
1 parent 6894ea0 commit dd3e817

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

Documentation/doc-guide/kernel-doc.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,10 @@ Domain`_ references.
405405
``%CONST``
406406
Name of a constant. (No cross-referencing, just formatting.)
407407

408+
Examples::
409+
410+
%0 %NULL %-1 %-EFAULT %-EINVAL %-ENOMEM
411+
408412
````literal````
409413
A literal block that should be handled as-is. The output will use a
410414
``monospaced font``.

0 commit comments

Comments
 (0)