linux-kernel - Re: [PATCH 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: <638eee89-dd74-4a7a-b780-03ac53860098@gmail.com>
Date: Fri, 7 Mar 2025 10:06:38 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Yury Norov <yury.norov@...il.com>
Cc: viresh.kumar@...aro.org, linux-kernel@...r.kernel.org,
 linux@...musvillemoes.dk, vincent.guittot@...aro.org,
 Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH 1/2] cpumask: Fix kernel-doc formatting errors in
 cpumask.h

Hi,

Yury Norov wrote:
> On Fri, Mar 07, 2025 at 12:38:41AM +0900, Akira Yokosawa wrote:
>> Hello Viresh,
>>
>> On Thu,  6 Mar 2025 16:06:50 +0530, Viresh Kumar wrote:
>>> This fixes various kernel-doc formatting errors in cpumask.h:
>>>
>>> - WARNING: Inline literal start-string without end-string.
>>> - ERROR: Unexpected indentation.
>>> - ERROR: Unknown target name: "gfp".
>>>
>>> Signed-off-by: Viresh Kumar <viresh.kumar@...aro.org>
>>> ---
>>>  include/linux/cpumask.h | 65 +++++++++++++++++++++++------------------
>>>  1 file changed, 37 insertions(+), 28 deletions(-)
>>>
>>> diff --git a/include/linux/cpumask.h b/include/linux/cpumask.h
>>> index 36a890d0dd57..73ba808c559f 100644
>>> --- a/include/linux/cpumask.h
>>> +++ b/include/linux/cpumask.h
>>> @@ -20,7 +20,7 @@
>>>   * cpumask_pr_args - printf args to output a cpumask
>>>   * @maskp: cpumask to be printed
>>>   *
>>> - * Can be used to provide arguments for '%*pb[l]' when printing a cpumask.
>>> + * Can be used to provide arguments for '\%*pb[l]' when printing a cpumask.
>>
>> kernel-doc (script) can recognize the pattern of %*pb but not %*pb[l].
>> "%*bp [l]" should work here.
>> (without quotes and a white space in front of "[").
> 
> So why not fixing kernel-doc instead?

That would be great!

At the moment, re-implementation of kernel-doc into python is under way [1].

[1]: https://lore.kernel.org/cover.1740387599.git.mchehab+huawei@kernel.org/

It is a bug compatible porting from perl to python3, but it is likely
to be merged during 6.16 merge window.

I think it would be nicer to do the fix on top of python3 kernel-doc
after that happens.

        Thanks, Akira

>  
>> No need to escape "%".
>>
>>>   */
>>>  #define cpumask_pr_args(maskp)		nr_cpu_ids, cpumask_bits(maskp)
>>>  
[...]