From: Akira Yokosawa <akiyks@gmail.com>
To: Viresh Kumar <viresh.kumar@linaro.org>,
Yury Norov <yury.norov@gmail.com>
Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk>,
Vincent Guittot <vincent.guittot@linaro.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Akira Yokosawa <akiyks@gmail.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in cpumask.h
Date: Mon, 10 Mar 2025 18:29:20 +0900 [thread overview]
Message-ID: <ed8add50-b146-4741-8ddc-010eea3ce169@gmail.com> (raw)
In-Reply-To: <20250310090319.olwxrcqczwjla2jm@vireshk-i7>
Hi,
Viresh Kumar wrote:
> On 10-03-25, 11:45, Viresh Kumar wrote:
>> On 07-03-25, 12:05, Yury Norov wrote:
>>>> /**
>>>> - * cpumask_weight - Count of bits in *srcp
>>>> + * cpumask_weight - Count of bits in *@srcp
>>>> * @srcp: the cpumask to count bits (< nr_cpu_ids) in.
>>>
>>> Here nr_cpu_ids is also a variable. Why you don't prefix it with @?
>
> Hmm, I thought @ is applied only to function arguments. Not sure what
> should be done with nr_cpu_ids.
>
> Akira ?
Section "Highlights and cross-references" in
Documentation/doc-guide/kernel-doc.sty says:
``@parameter``
Name of a function parameter. (No cross-referencing, just formatting.)
It's just formatting. Putting "@" to a non argument name won't result
in any warning. (At least current kernel-doc goes.)
kernel-doc is just our own convention, which can change any moment,
hopefully in backward compatible manner.
next prev parent reply other threads:[~2025-03-10 9:29 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-07 7:34 [PATCH V2 0/2] docs: core-api: Update kernel-api.rst to include cpumask.h Viresh Kumar
2025-03-07 7:34 ` [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in cpumask.h Viresh Kumar
2025-03-07 9:02 ` Akira Yokosawa
2025-03-07 10:57 ` Akira Yokosawa
2025-03-07 11:28 ` Viresh Kumar
2025-03-07 11:20 ` Akira Yokosawa
2025-03-07 17:05 ` Yury Norov
2025-03-10 6:15 ` Viresh Kumar
2025-03-10 9:03 ` Viresh Kumar
2025-03-10 9:29 ` Akira Yokosawa [this message]
2025-03-10 9:11 ` Akira Yokosawa
2025-03-10 14:07 ` Jonathan Corbet
2025-03-10 14:43 ` Mauro Carvalho Chehab
2025-03-17 9:24 ` Viresh Kumar
2025-03-10 14:53 ` Mauro Carvalho Chehab
2025-03-10 15:27 ` Akira Yokosawa
2025-03-10 15:56 ` Mauro Carvalho Chehab
2025-03-17 8:53 ` Viresh Kumar
2025-03-07 7:34 ` [PATCH V2 2/2] docs: core-api: Update kernel-api.rst to include cpumask.h Viresh Kumar
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=ed8add50-b146-4741-8ddc-010eea3ce169@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@rasmusvillemoes.dk \
--cc=vincent.guittot@linaro.org \
--cc=viresh.kumar@linaro.org \
--cc=yury.norov@gmail.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;
as well as URLs for NNTP newsgroup(s).