Re: [PATCH v2] locking/atomic: scripts: fix ${atomic}_sub_and_test() kerneldoc

Mark Rutland
2024-05-16T08:46:06Z

On Wed, May 15, 2024 at 01:37:10PM +0000, Carlos Llamas wrote:
> 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")
> Cc: Mark Rutland <mark.rutland@arm.com>
> Cc: stable@vger.kernel.org
> Suggested-by: Mark Rutland <mark.rutland@arm.com>
> Reviewed-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Carlos Llamas <cmllamas@google.com>
> ---
>
> Notes:
> v2: fix kerneldoc template instead, as pointed out by Mark

Thanks for this!

Acked-by: Mark Rutland <mark.rutland@arm.com>

Peter, Ingo, are you happy to queue this up in the tip tree?

Thanks,
Mark.

>
> include/linux/atomic/atomic-arch-fallback.h | 6 +++---
> include/linux/atomic/atomic-instrumented.h | 8 ++++----
> include/linux/atomic/atomic-long.h | 4 ++--
> scripts/atomic/kerneldoc/sub_and_test | 2 +-
> 4 files changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/include/linux/atomic/atomic-arch-fallback.h b/include/linux/atomic/atomic-arch-fallback.h
> index 956bcba5dbf2..2f9d36b72bd8 100644
> --- a/include/linux/atomic/atomic-arch-fallback.h
> +++ b/include/linux/atomic/atomic-arch-fallback.h
> @@ -2242,7 +2242,7 @@ raw_atomic_try_cmpxchg_relaxed(atomic_t *v, int *old, int new)
>
> /**
> * raw_atomic_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: int value to add
> + * @i: int value to subtract
> * @v: pointer to atomic_t
> *
> * Atomically updates @v to (@v - @i) with full ordering.
> @@ -4368,7 +4368,7 @@ raw_atomic64_try_cmpxchg_relaxed(atomic64_t *v, s64 *old, s64 new)
>
> /**
> * raw_atomic64_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: s64 value to add
> + * @i: s64 value to subtract
> * @v: pointer to atomic64_t
> *
> * Atomically updates @v to (@v - @i) with full ordering.
> @@ -4690,4 +4690,4 @@ raw_atomic64_dec_if_positive(atomic64_t *v)
> }
>
> #endif /* _LINUX_ATOMIC_FALLBACK_H */
> -// 14850c0b0db20c62fdc78ccd1d42b98b88d76331
> +// b565db590afeeff0d7c9485ccbca5bb6e155749f
> diff --git a/include/linux/atomic/atomic-instrumented.h b/include/linux/atomic/atomic-instrumented.h
> index debd487fe971..9409a6ddf3e0 100644
> --- a/include/linux/atomic/atomic-instrumented.h
> +++ b/include/linux/atomic/atomic-instrumented.h
> @@ -1349,7 +1349,7 @@ atomic_try_cmpxchg_relaxed(atomic_t *v, int *old, int new)
>
> /**
> * atomic_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: int value to add
> + * @i: int value to subtract
> * @v: pointer to atomic_t
> *
> * Atomically updates @v to (@v - @i) with full ordering.
> @@ -2927,7 +2927,7 @@ atomic64_try_cmpxchg_relaxed(atomic64_t *v, s64 *old, s64 new)
>
> /**
> * atomic64_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: s64 value to add
> + * @i: s64 value to subtract
> * @v: pointer to atomic64_t
> *
> * Atomically updates @v to (@v - @i) with full ordering.
> @@ -4505,7 +4505,7 @@ atomic_long_try_cmpxchg_relaxed(atomic_long_t *v, long *old, long new)
>
> /**
> * atomic_long_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: long value to add
> + * @i: long value to subtract
> * @v: pointer to atomic_long_t
> *
> * Atomically updates @v to (@v - @i) with full ordering.
> @@ -5050,4 +5050,4 @@ atomic_long_dec_if_positive(atomic_long_t *v)
>
>
> #endif /* _LINUX_ATOMIC_INSTRUMENTED_H */
> -// ce5b65e0f1f8a276268b667194581d24bed219d4
> +// 8829b337928e9508259079d32581775ececd415b
> diff --git a/include/linux/atomic/atomic-long.h b/include/linux/atomic/atomic-long.h
> index 3ef844b3ab8a..f86b29d90877 100644
> --- a/include/linux/atomic/atomic-long.h
> +++ b/include/linux/atomic/atomic-long.h
> @@ -1535,7 +1535,7 @@ raw_atomic_long_try_cmpxchg_relaxed(atomic_long_t *v, long *old, long new)
>
> /**
> * raw_atomic_long_sub_and_test() - atomic subtract and test if zero with full ordering
> - * @i: long value to add
> + * @i: long value to subtract
> * @v: pointer to atomic_long_t
> *
> * Atomically updates @v to (@v - @i) with full ordering.
> @@ -1809,4 +1809,4 @@ raw_atomic_long_dec_if_positive(atomic_long_t *v)
> }
>
> #endif /* _LINUX_ATOMIC_LONG_H */
> -// 1c4a26fc77f345342953770ebe3c4d08e7ce2f9a
> +// eadf183c3600b8b92b91839dd3be6bcc560c752d
> 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.
> --
> 2.45.0.rc1.225.g2a3ae87e7f-goog
>