linux-kernel - Re: [PATCH] doc-guide: kernel-doc: add %CONST examples

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <877bw472q0.fsf@trenco.lwn.net>
Date: Wed, 05 Nov 2025 11:29:11 -0700
From: Jonathan Corbet <corbet@....net>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>, Tony Luck <tony.luck@...el.com>,
 linux-doc@...r.kernel.org
Subject: Re: [PATCH] doc-guide: kernel-doc: add %CONST examples

Randy Dunlap <rdunlap@...radead.org> writes:

> Add examples of using '%' for formatting constant values to
> facilitate more usage of "%CONST" in kernel-doc.
>
> Suggested-by: Tony Luck <tony.luck@...el.com>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> ---
>  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