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: <cb168a2c-d14c-4c7d-92ea-ab70194545a9@gmail.com>
Date: Fri, 7 Mar 2025 18:02:35 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Viresh Kumar <viresh.kumar@...aro.org>
Cc: Vincent Guittot <vincent.guittot@...aro.org>, linux-doc@...r.kernel.org,
 Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
 Akira Yokosawa <akiyks@...il.com>,
 Rasmus Villemoes <linux@...musvillemoes.dk>,
 Yury Norov <yury.norov@...il.com>
Subject: Re: [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in
 cpumask.h

Hi,

Only a couple of minor nits.

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, 34 insertions(+), 31 deletions(-)
> 
[...]

> @@ -667,7 +670,7 @@ void cpumask_xor(struct cpumask *dstp, const struct cpumask *src1p,
>  }
>  
>  /**
> - * cpumask_andnot - *dstp = *src1p & ~*src2p
> + * cpumask_andnot - *@...p = *@...1p & ~*@...2p

The latter part needs to be "&~ *@...2p".

Note: kernel-doc (script) recognizes the pattern of *@...e, but not ~*@...e
at the moment.  (No warning from Sphinx, but the rendered doc doesn't look
right.)

>   * @dstp: the cpumask result
>   * @src1p: the first input
>   * @src2p: the second input
[...]

> @@ -729,7 +732,7 @@ bool cpumask_intersects(const struct cpumask *src1p, const struct cpumask *src2p
>  }
>  
>  /**
> - * cpumask_subset - (*src1p & ~*src2p) == 0
> + * cpumask_subset - (*@...1p & ~*@...2p) == 0

Ditto.

>   * @src1p: the first input
>   * @src2p: the second input
>   *
[...]

> @@ -789,11 +792,11 @@ unsigned int cpumask_weight_and(const struct cpumask *srcp1, const struct cpumas
>  }
>  
>  /**
> - * cpumask_weight_andnot - Count of bits in (*srcp1 & ~*srcp2)
> + * cpumask_weight_andnot - Count of bits in (*@...p1 & ~*@...p2)

Ditto.

With above patterns taken care of:
Reviewed-by: Akira Yokosawa <akiyks@...il.com>

>   * @srcp1: the cpumask to count bits (< nr_cpu_ids) in.
>   * @srcp2: the cpumask to count bits (< nr_cpu_ids) in.
>   *
> - * Return: count of bits set in both *srcp1 and *srcp2
> + * Return: count of bits set in both *@...p1 and *@...p2
>   */
>  static __always_inline
>  unsigned int cpumask_weight_andnot(const struct cpumask *srcp1,
[...]

        Thanks, Akira