Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Randy Dunlap and committed by
Jonathan Corbet
dd3e817e 6894ea0b

+4
+4
Documentation/doc-guide/kernel-doc.rst
··· 405 405 ``%CONST`` 406 406 Name of a constant. (No cross-referencing, just formatting.) 407 407 408 + Examples:: 409 + 410 + %0 %NULL %-1 %-EFAULT %-EINVAL %-ENOMEM 411 + 408 412 ````literal```` 409 413 A literal block that should be handled as-is. The output will use a 410 414 ``monospaced font``.