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: <20250307112812.3la74kiomyqbzhk5@vireshk-i7>
Date: Fri, 7 Mar 2025 16:58:12 +0530
From: Viresh Kumar <viresh.kumar@...aro.org>
To: Akira Yokosawa <akiyks@...il.com>
Cc: Vincent Guittot <vincent.guittot@...aro.org>, linux-doc@...r.kernel.org,
	Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
	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

On 07-03-25, 19:57, Akira Yokosawa wrote:
> Didn't come up in your diff, but you need additional changes shown below:
> 
> diff --git a/include/linux/cpumask.h b/include/linux/cpumask.h
> index 656d2208467e..a6c1961cc535 100644
> --- a/include/linux/cpumask.h
> +++ b/include/linux/cpumask.h
> @@ -285,10 +285,10 @@ unsigned int cpumask_next_and(int n, const struct cpumask *src1p,
>  }
>  
>  /**
> - * cpumask_next_and_wrap - get the next cpu in *src1p & *src2p, starting from
> - *                        @n+1. If nothing found, wrap around and start from
> + * cpumask_next_and_wrap - get the next cpu in *@...1p & *@...2p, starting from
> + *                        @n+ 1. If nothing found, wrap around and start from
>   *                        the beginning
> - * @n: the cpu prior to the place to search (i.e. search starts from @n+1)
> + * @n: the cpu prior to the place to search (i.e. search starts from @n +1)
>   * @src1p: the first cpumask pointer
>   * @src2p: the second cpumask pointer
>   *
> @@ -306,9 +306,9 @@ unsigned int cpumask_next_and_wrap(int n, const struct cpumask *src1p,
>  }
>  
>  /**
> - * cpumask_next_wrap - get the next cpu in *src, starting from @n+1. If nothing
> + * cpumask_next_wrap - get the next cpu in *@src, starting from @n +1. If nothing
>   *                    found, wrap around and start from the beginning
> - * @n: the cpu prior to the place to search (i.e. search starts from @n+1)
> + * @n: the cpu prior to the place to search (i.e. search starts from @n +1)
>   * @src: cpumask pointer
>   *
>   * Return: next set bit, wrapped if needed, or >= nr_cpu_ids if @src is empty.

How did you find these ? I only looked for build warnings / errors earlier (with
make htmldocs). Anything else I should be doing to find these issues ?

Thanks for your help Akira.

-- 
viresh