Stable Archive mirror
 help / color / mirror / Atom feed
From: Carlos Llamas <cmllamas@google.com>
To: Mark Rutland <mark.rutland@arm.com>,
	Peter Zijlstra <peterz@infradead.org>,
	 Kees Cook <keescook@chromium.org>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	 Ingo Molnar <mingo@kernel.org>,
	Carlos Llamas <cmllamas@google.com>,
	Uros Bizjak <ubizjak@gmail.com>
Cc: linux-kernel@vger.kernel.org, kernel-team@android.com,
	 stable@vger.kernel.org, Arnd Bergmann <arnd@arndb.de>
Subject: [PATCH] locking/atomic: fix trivial typo in comment
Date: Tue, 14 May 2024 22:46:03 +0000	[thread overview]
Message-ID: <20240514224625.3280818-1-cmllamas@google.com> (raw)

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@arm.com>
Cc: stable@vger.kernel.org
Signed-off-by: Carlos Llamas <cmllamas@google.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


             reply	other threads:[~2024-05-14 22:46 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-14 22:46 Carlos Llamas [this message]
2024-05-14 22:48 ` [PATCH] locking/atomic: fix trivial typo in comment Kees Cook
2024-05-15  5:04 ` kernel test robot
2024-05-15  8:11 ` Mark Rutland
2024-05-15 13:16   ` Carlos Llamas
2024-05-15 13:37   ` [PATCH v2] locking/atomic: scripts: fix ${atomic}_sub_and_test() kerneldoc Carlos Llamas
2024-05-16  8:45     ` Mark Rutland
2024-05-16  8:53       ` Peter Zijlstra
2024-05-16  9:49         ` Peter Zijlstra
2024-05-16 10:02           ` Mark Rutland

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240514224625.3280818-1-cmllamas@google.com \
    --to=cmllamas@google.com \
    --cc=arnd@arndb.de \
    --cc=keescook@chromium.org \
    --cc=kernel-team@android.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mingo@kernel.org \
    --cc=paulmck@kernel.org \
    --cc=peterz@infradead.org \
    --cc=stable@vger.kernel.org \
    --cc=ubizjak@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).