linux-kernel - [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-next>] [day] [month] [year] [list]

Message-ID: <20240514224625.3280818-1-cmllamas@google.com>
Date: Tue, 14 May 2024 22:46:03 +0000
From: Carlos Llamas <cmllamas@...gle.com>
To: Mark Rutland <mark.rutland@....com>, Peter Zijlstra <peterz@...radead.org>, 
	Kees Cook <keescook@...omium.org>, "Paul E. McKenney" <paulmck@...nel.org>, 
	Ingo Molnar <mingo@...nel.org>, Carlos Llamas <cmllamas@...gle.com>, Uros Bizjak <ubizjak@...il.com>
Cc: linux-kernel@...r.kernel.org, kernel-team@...roid.com, 
	stable@...r.kernel.org, Arnd Bergmann <arnd@...db.de>
Subject: [PATCH] locking/atomic: fix trivial typo in comment

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
  *
  * Atomically updates @v to (@v - @i) with full ordering.
-- 
2.45.0.rc1.225.g2a3ae87e7f-goog