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>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: kernel-doc: inform that '@' applies to other fields
Date: Tue, 15 Sep 2026 13:02:43 -0600	[thread overview]
Message-ID: <87a4pi9w30.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20260911184213.4143776-1-rdunlap@infradead.org>

Randy Dunlap <rdunlap@infradead.org> writes:

> The '@' sign applies to struct members, union members, and enum
> values as well as function parameters. Document that.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Cc: linux-doc@vger.kernel.org
>
>  Documentation/doc-guide/kernel-doc.rst |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> --- linux-next-20260911.orig/Documentation/doc-guide/kernel-doc.rst
> +++ linux-next-20260911/Documentation/doc-guide/kernel-doc.rst
> @@ -422,7 +422,8 @@ Domain`_ references.
>    Function reference.
>  
>  ``@parameter``
> -  Name of a function parameter. (No cross-referencing, just formatting.)
> +  Name of a function parameter, struct member, union member, or
> +  enum value. (No cross-referencing, just formatting.)

Applied, thanks.

jon

      reply	other threads:[~2026-09-15 19:02 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-11 18:42 Randy Dunlap
2026-09-15 19:02 ` 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=87a4pi9w30.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    /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®