mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Tony Luck <tony.luck@intel.com>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] doc-guide: kernel-doc: add %CONST examples
Date: Wed, 05 Nov 2025 11:29:11 -0700	[thread overview]
Message-ID: <877bw472q0.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20251104050930.720711-1-rdunlap@infradead.org>

Randy Dunlap <rdunlap@infradead.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@intel.com>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.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

      reply	other threads:[~2025-11-05 18:29 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-04  5:09 Randy Dunlap
2025-11-05 18:29 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=877bw472q0.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=tony.luck@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®