linux/scripts/atomic
Mark Rutland b33eb50a92 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: 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
2023-06-16 16:46:30 +02:00
..
fallbacks locking/atomic: scripts: simplify raw_atomic*() definitions 2023-06-05 09:57:22 +02:00
kerneldoc locking/atomic: scripts: fix ${atomic}_dec_if_positive() kerneldoc 2023-06-16 16:46:30 +02:00
atomic-tbl.sh locking/atomic: scripts: generate kerneldoc comments 2023-06-05 09:57:23 +02:00
atomics.tbl locking/atomic: scripts: simplify raw_atomic*() definitions 2023-06-05 09:57:22 +02:00
gen-atomic-fallback.sh locking/atomic: scripts: generate kerneldoc comments 2023-06-05 09:57:23 +02:00
gen-atomic-instrumented.sh locking/atomic: scripts: generate kerneldoc comments 2023-06-05 09:57:23 +02:00
gen-atomic-long.sh locking/atomic: scripts: generate kerneldoc comments 2023-06-05 09:57:23 +02:00
gen-atomics.sh locking/atomic: scripts: restructure fallback ifdeffery 2023-06-05 09:57:21 +02:00