summaryrefslogtreecommitdiffstats
path: root/scripts/atomic
diff options
context:
space:
mode:
authorCarlos Llamas <cmllamas@google.com>2024-05-15 15:37:10 +0200
committerPeter Zijlstra <peterz@infradead.org>2024-06-05 15:52:34 +0200
commitf92a59f6d12e31ead999fee9585471b95a8ae8a3 (patch)
treedffddd91cd2cb0c197c65e60967cfa11a24c9a6e /scripts/atomic
parentLinux 6.10-rc2 (diff)
downloadlinux-f92a59f6d12e31ead999fee9585471b95a8ae8a3.tar.xz
linux-f92a59f6d12e31ead999fee9585471b95a8ae8a3.zip
locking/atomic: scripts: fix ${atomic}_sub_and_test() kerneldoc
For ${atomic}_sub_and_test() the @i parameter is the value to subtract, not add. Fix the typo in the kerneldoc template and generate the headers with this update. Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments") Suggested-by: Mark Rutland <mark.rutland@arm.com> Signed-off-by: Carlos Llamas <cmllamas@google.com> Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org> Acked-by: Mark Rutland <mark.rutland@arm.com> Reviewed-by: Kees Cook <keescook@chromium.org> Cc: stable@vger.kernel.org Link: https://lkml.kernel.org/r/20240515133844.3502360-1-cmllamas@google.com
Diffstat (limited to 'scripts/atomic')
-rw-r--r--scripts/atomic/kerneldoc/sub_and_test2
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/atomic/kerneldoc/sub_and_test b/scripts/atomic/kerneldoc/sub_and_test
index d3760f7749d4..96615e50836b 100644
--- a/scripts/atomic/kerneldoc/sub_and_test
+++ b/scripts/atomic/kerneldoc/sub_and_test
@@ -1,7 +1,7 @@
cat <<EOF
/**
* ${class}${atomicname}() - atomic subtract and test if zero with ${desc_order} ordering
- * @i: ${int} value to add
+ * @i: ${int} value to subtract
* @v: pointer to ${atomic}_t
*
* Atomically updates @v to (@v - @i) with ${desc_order} ordering.