locking/atomic: scripts: fix ${atomic}_dec_if_positive() kerneldoc
authorMark Rutland <mark.rutland@arm.com>
Thu, 15 Jun 2023 13:27:34 +0000 (14:27 +0100)
committerPeter Zijlstra <peterz@infradead.org>
Fri, 16 Jun 2023 14:46:30 +0000 (16:46 +0200)
commitb33eb50a92b0a298fa8a6ac350e741c3ec100f6d
tree3026dae3d961623a895130facdb0ec47ea5e5254
parent093d9b240a1fa261ff8aeb7c7cc484dedacfda53
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
include/linux/atomic/atomic-arch-fallback.h
include/linux/atomic/atomic-instrumented.h
include/linux/atomic/atomic-long.h
scripts/atomic/kerneldoc/dec_if_positive