admin/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2025-12-07 20:06:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc-guide: kernel-doc: add %CONST examples

Browse Source 
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>
This commit is contained in:
Randy Dunlap
2025-11-03 21:09:30 -08:00
committed by Jonathan Corbet
parent 6894ea0b9a
commit dd3e817e87
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/doc-guide/kernel-doc.rst
View 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``.