diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2025-11-03 21:09:30 -0800 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-11-05 11:27:12 -0700 |
| commit | dd3e817e879c8c0e640b1afaed67a00935483b87 (patch) | |
| tree | 0bfaea9d312fbcdcd93226bf7966ab0996961d2b /Documentation/doc-guide | |
| parent | 6894ea0b9ab507f8571ff8d63531112bfec02085 (diff) | |
| download | net-dd3e817e879c8c0e640b1afaed67a00935483b87.tar.gz | |
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>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 4370cc8fbcf5e5..fd89a6d56ea9af 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -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``. |