For atomic_sub_and_test() the @i parameter is the value to subtract, not
add. Fix the kerneldoc comment accordingly.
Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
Cc: Mark Rutland <[email protected]>
Cc: [email protected]
Signed-off-by: Carlos Llamas <[email protected]>
---
include/linux/atomic/atomic-instrumented.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/atomic/atomic-instrumented.h b/include/linux/atomic/atomic-instrumented.h
index debd487fe971..12b558c05384 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.
--
2.45.0.rc1.225.g2a3ae87e7f-goog
On Tue, May 14, 2024 at 10:46:03PM +0000, Carlos Llamas wrote:
> For atomic_sub_and_test() the @i parameter is the value to subtract, not
> add. Fix the kerneldoc comment accordingly.
>
> Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
> Cc: Mark Rutland <[email protected]>
> Cc: [email protected]
> Signed-off-by: Carlos Llamas <[email protected]>
Thanks!
Reviewed-by: Kees Cook <[email protected]>
--
Kees Cook
Hi Carlos,
kernel test robot noticed the following build errors:
[auto build test ERROR on kees/for-next/pstore]
[also build test ERROR on kees/for-next/kspp linus/master v6.9 next-20240514]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Carlos-Llamas/locking-atomic-fix-trivial-typo-in-comment/20240515-064934
base: https://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git for-next/pstore
patch link: https://lore.kernel.org/r/20240514224625.3280818-1-cmllamas%40google.com
patch subject: [PATCH] locking/atomic: fix trivial typo in comment
config: openrisc-defconfig (https://download.01.org/0day-ci/archive/20240515/[email protected]/config)
compiler: or1k-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240515/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>):
>> error: include/linux/atomic/atomic-instrumented.h has been modified.
make[3]: *** [./Kbuild:68: .checked-atomic-instrumented.h] Error 1
make[3]: Target 'prepare' not remade because of errors.
make[2]: *** [Makefile:1197: prepare0] Error 2
make[2]: Target 'prepare' not remade because of errors.
make[1]: *** [Makefile:240: __sub-make] Error 2
make[1]: Target 'prepare' not remade because of errors.
make: *** [Makefile:240: __sub-make] Error 2
make: Target 'prepare' not remade because of errors.
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
Hi Carlos,
On Tue, May 14, 2024 at 10:46:03PM +0000, Carlos Llamas wrote:
> For atomic_sub_and_test() the @i parameter is the value to subtract, not
> add. Fix the kerneldoc comment accordingly.
>
> Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
> Cc: Mark Rutland <[email protected]>
> Cc: [email protected]
> Signed-off-by: Carlos Llamas <[email protected]>
> ---
> include/linux/atomic/atomic-instrumented.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/atomic/atomic-instrumented.h b/include/linux/atomic/atomic-instrumented.h
> index debd487fe971..12b558c05384 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
Whoops; sorry about that.
The atomic headers are generated, and this kerneldoc comment is
generated from the template in scripts/atomic/kerneldoc/sub_and_test
You'll need to modify that then run:
sh scripts/atomic/gen-atomics.sh
.. to regenerate all the affected instances of ${atomic}_sub_and_test()
Thanks,
Mark.
On Wed, May 15, 2024 at 10:11:29AM +0200, Mark Rutland wrote:
> Hi Carlos,
>
> On Tue, May 14, 2024 at 10:46:03PM +0000, Carlos Llamas wrote:
> > For atomic_sub_and_test() the @i parameter is the value to subtract, not
> > add. Fix the kerneldoc comment accordingly.
> >
> > Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
> > Cc: Mark Rutland <[email protected]>
> > Cc: [email protected]
> > Signed-off-by: Carlos Llamas <[email protected]>
> > ---
> > include/linux/atomic/atomic-instrumented.h | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/include/linux/atomic/atomic-instrumented.h b/include/linux/atomic/atomic-instrumented.h
> > index debd487fe971..12b558c05384 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
>
> Whoops; sorry about that.
>
> The atomic headers are generated, and this kerneldoc comment is
> generated from the template in scripts/atomic/kerneldoc/sub_and_test
Oh I see. Sorry, I wasn't aware of this.
>
> You'll need to modify that then run:
>
> sh scripts/atomic/gen-atomics.sh
>
> ... to regenerate all the affected instances of ${atomic}_sub_and_test()
Ok, let me go do that. Thanks!
>
> Thanks,
> Mark.
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 <[email protected]>
Cc: [email protected]
Suggested-by: Mark Rutland <[email protected]>
Reviewed-by: Kees Cook <[email protected]>
Signed-off-by: Carlos Llamas <[email protected]>
---
Notes:
v2: fix kerneldoc template instead, as pointed out by 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
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 <[email protected]>
> Cc: [email protected]
> Suggested-by: Mark Rutland <[email protected]>
> Reviewed-by: Kees Cook <[email protected]>
> Signed-off-by: Carlos Llamas <[email protected]>
> ---
>
> Notes:
> v2: fix kerneldoc template instead, as pointed out by Mark
Thanks for this!
Acked-by: Mark Rutland <[email protected]>
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
>
On Thu, May 16, 2024 at 10:45:58AM +0200, Mark Rutland wrote:
> 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 <[email protected]>
> > Cc: [email protected]
> > Suggested-by: Mark Rutland <[email protected]>
> > Reviewed-by: Kees Cook <[email protected]>
> > Signed-off-by: Carlos Llamas <[email protected]>
> > ---
> >
> > Notes:
> > v2: fix kerneldoc template instead, as pointed out by Mark
>
> Thanks for this!
>
> Acked-by: Mark Rutland <[email protected]>
>
> Peter, Ingo, are you happy to queue this up in the tip tree?
Yep can do. I'll sit on it until after the merge window though.
On Thu, May 16, 2024 at 10:53:10AM +0200, Peter Zijlstra wrote:
> On Thu, May 16, 2024 at 10:45:58AM +0200, Mark Rutland wrote:
> > 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 <[email protected]>
> > > Cc: [email protected]
> > > Suggested-by: Mark Rutland <[email protected]>
> > > Reviewed-by: Kees Cook <[email protected]>
> > > Signed-off-by: Carlos Llamas <[email protected]>
> > > ---
> > >
> > > Notes:
> > > v2: fix kerneldoc template instead, as pointed out by Mark
> >
> > Thanks for this!
> >
> > Acked-by: Mark Rutland <[email protected]>
> >
> > Peter, Ingo, are you happy to queue this up in the tip tree?
>
> Yep can do. I'll sit on it until after the merge window though.
Also, do we really want this in stable? It's just a silly doc change.
On Thu, May 16, 2024 at 11:49:20AM +0200, Peter Zijlstra wrote:
> On Thu, May 16, 2024 at 10:53:10AM +0200, Peter Zijlstra wrote:
> > On Thu, May 16, 2024 at 10:45:58AM +0200, Mark Rutland wrote:
> > > 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 <[email protected]>
> > > > Cc: [email protected]
> > > > Suggested-by: Mark Rutland <[email protected]>
> > > > Reviewed-by: Kees Cook <[email protected]>
> > > > Signed-off-by: Carlos Llamas <[email protected]>
> > > > ---
> > > >
> > > > Notes:
> > > > v2: fix kerneldoc template instead, as pointed out by Mark
> > >
> > > Thanks for this!
> > >
> > > Acked-by: Mark Rutland <[email protected]>
> > >
> > > Peter, Ingo, are you happy to queue this up in the tip tree?
> >
> > Yep can do. I'll sit on it until after the merge window though.
>
> Also, do we really want this in stable? It's just a silly doc change.
I think that we do, so that when people look at the generated docs for
stable kernels they see the right thing.
It *should* be a trivial backport, anyhow.
Mark.
The following commit has been merged into the locking/urgent branch of tip:
Commit-ID: f92a59f6d12e31ead999fee9585471b95a8ae8a3
Gitweb: https://git.kernel.org/tip/f92a59f6d12e31ead999fee9585471b95a8ae8a3
Author: Carlos Llamas <[email protected]>
AuthorDate: Wed, 15 May 2024 13:37:10
Committer: Peter Zijlstra <[email protected]>
CommitterDate: Wed, 05 Jun 2024 15:52:34 +02:00
locking/atomic: scripts: fix ${atomic}_sub_and_test() kerneldoc
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")
Suggested-by: Mark Rutland <[email protected]>
Signed-off-by: Carlos Llamas <[email protected]>
Signed-off-by: Peter Zijlstra (Intel) <[email protected]>
Acked-by: Mark Rutland <[email protected]>
Reviewed-by: Kees Cook <[email protected]>
Cc: [email protected]
Link: https://lkml.kernel.org/r/[email protected]
---
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 956bcba..2f9d36b 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 debd487..9409a6d 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 3ef844b..f86b29d 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 d3760f7..96615e5 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.