Re: [PATCH] doc-guide: kernel-doc: add %CONST examples
From: Jonathan Corbet
Date: Wed Nov 05 2025 - 13:29:13 EST
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> writes:
> Add examples of using '%' for formatting constant values to
> facilitate more usage of "%CONST" in kernel-doc.
>
> Suggested-by: Tony Luck <tony.luck@xxxxxxxxx>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> ---
> Documentation/doc-guide/kernel-doc.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>
> --- linux-next-20251103.orig/Documentation/doc-guide/kernel-doc.rst
> +++ linux-next-20251103/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``.
Applied, thanks.
jon