linux-kernel - Re: [PATCH] locking/atomic: fix trivial typo in comment

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]

Date: Wed, 15 May 2024 10:11:29 +0200
From: Mark Rutland <mark.rutland@....com>
To: Carlos Llamas <cmllamas@...gle.com>
Cc: Peter Zijlstra <peterz@...radead.org>,
	Kees Cook <keescook@...omium.org>,
	"Paul E. McKenney" <paulmck@...nel.org>,
	Ingo Molnar <mingo@...nel.org>, Uros Bizjak <ubizjak@...il.com>,
	linux-kernel@...r.kernel.org, kernel-team@...roid.com,
	stable@...r.kernel.org, Arnd Bergmann <arnd@...db.de>
Subject: Re: [PATCH] locking/atomic: fix trivial typo in comment

Hi Carlos,

On Tue, May 14, 2024 at 10:46:03PM +0000, Carlos Llamas wrote:
> For atomic_sub_and_test() the @i parameter is the value to subtract, not
> add. Fix the kerneldoc comment accordingly.
> 
> Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
> Cc: Mark Rutland <mark.rutland@....com>
> Cc: stable@...r.kernel.org
> Signed-off-by: Carlos Llamas <cmllamas@...gle.com>
> ---
>  include/linux/atomic/atomic-instrumented.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/atomic/atomic-instrumented.h b/include/linux/atomic/atomic-instrumented.h
> index debd487fe971..12b558c05384 100644
> --- a/include/linux/atomic/atomic-instrumented.h
> +++ b/include/linux/atomic/atomic-instrumented.h
> @@ -1349,7 +1349,7 @@ atomic_try_cmpxchg_relaxed(atomic_t *v, int *old, int new)
>  
>  /**
>   * atomic_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: int value to add
> + * @i: int value to subtract
>   * @v: pointer to atomic_t

Whoops; sorry about that.

The atomic headers are generated, and this kerneldoc comment is
generated from the template in scripts/atomic/kerneldoc/sub_and_test

You'll need to modify that then run:

  sh scripts/atomic/gen-atomics.sh

.. to regenerate all the affected instances of ${atomic}_sub_and_test()

Thanks,
Mark.