diff options
| author | Mark Rutland | 2023-06-15 14:27:34 +0100 |
|---|---|---|
| committer | Peter Zijlstra | 2023-06-16 16:46:30 +0200 |
| commit | b33eb50a92b0a298fa8a6ac350e741c3ec100f6d (patch) | |
| tree | 3026dae3d961623a895130facdb0ec47ea5e5254 /scripts | |
| parent | 093d9b240a1fa261ff8aeb7c7cc484dedacfda53 (diff) | |
locking/atomic: scripts: fix ${atomic}_dec_if_positive() kerneldoc
The ${atomic}_dec_if_positive() ops are unlike all the other conditional
atomic ops. Rather than returning a boolean success value, these return
the value that the atomic variable would be updated to, even when no
update is performed.
We missed this when adding kerneldoc comments, and the documentation for
${atomic}_dec_if_positive() erroneously states:
| Return: @true if @v was updated, @false otherwise.
Ideally we'd clean this up by aligning ${atomic}_dec_if_positive() with
the usual atomic op conventions: with ${atomic}_fetch_dec_if_positive()
for those who care about the value of the varaible, and
${atomic}_dec_if_positive() returning a boolean success value.
In the mean time, align the documentation with the current reality.
Fixes: ad8110706f381170 ("locking/atomic: scripts: generate kerneldoc comments")
Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: Paul E. McKenney <paulmck@kernel.org>
Link: https://lore.kernel.org/r/20230615132734.1119765-1-mark.rutland@arm.com
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/atomic/kerneldoc/dec_if_positive | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/atomic/kerneldoc/dec_if_positive b/scripts/atomic/kerneldoc/dec_if_positive index 7c742866fb6b..04f1aed3cf83 100644 --- a/scripts/atomic/kerneldoc/dec_if_positive +++ b/scripts/atomic/kerneldoc/dec_if_positive @@ -7,6 +7,6 @@ cat <<EOF * * ${desc_noinstr} * - * Return: @true if @v was updated, @false otherwise. + * Return: The old value of (@v - 1), regardless of whether @v was updated. */ EOF |