mirror of
https://github.com/torvalds/linux.git
synced 2024-11-14 16:12:02 +00:00
b33eb50a92
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: ad8110706f ("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
13 lines
321 B
Plaintext
13 lines
321 B
Plaintext
cat <<EOF
|
|
/**
|
|
* ${class}${atomicname}() - atomic decrement if positive with ${desc_order} ordering
|
|
* @v: pointer to ${atomic}_t
|
|
*
|
|
* If (@v > 0), atomically updates @v to (@v - 1) with ${desc_order} ordering.
|
|
*
|
|
* ${desc_noinstr}
|
|
*
|
|
* Return: The old value of (@v - 1), regardless of whether @v was updated.
|
|
*/
|
|
EOF
|