linux-kernel - Re: [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in cpumask.h

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <ed8add50-b146-4741-8ddc-010eea3ce169@gmail.com>
Date: Mon, 10 Mar 2025 18:29:20 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Viresh Kumar <viresh.kumar@...aro.org>, Yury Norov <yury.norov@...il.com>
Cc: Rasmus Villemoes <linux@...musvillemoes.dk>,
 Vincent Guittot <vincent.guittot@...aro.org>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, Akira Yokosawa <akiyks@...il.com>,
 Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in
 cpumask.h

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 *@...p
>>>>   * @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:

    ``@...ameter``
    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.