Re: [PATCH v13 07/15] atomic: Add atomic_cond_read_*_timeout()

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] Documentation introduces misleading API grouping and broken grammar.
--

commit aa3c9c6efe8c1dbd47a496d3ac3a6bd26a933d98
Author: Ankur Arora <ankur.a.arora@oracle.com>

atomic: Add atomic_cond_read_*_timeout()

This commit adds atomic load wrappers for conditional load timeout interfaces.
It also provides short documentation updates for the relaxed and acquire 
variants of the atomic_cond_read interfaces.

> diff --git a/Documentation/atomic_t.txt b/Documentation/atomic_t.txt
> index bee3b1bca9a7b..0e53f6ccb5580 100644
> --- a/Documentation/atomic_t.txt
> +++ b/Documentation/atomic_t.txt
> @@ -16,6 +16,10 @@ Non-RMW ops:
>    atomic_read(), atomic_set()
>    atomic_read_acquire(), atomic_set_release()
>  
> +Non-RMW, non-atomic_t ops:
> +
> +  atomic_cond_read_{relaxed,acquire}()

[Severity: Low]
This isn't a bug, but should atomic_cond_read_{relaxed,acquire}() be grouped
under "non-atomic_t ops"? They still take an atomic_t pointer as their primary
argument, so this heading seems misleading.

> +  atomic_cond_read_{relaxed,acquire}_timeout()

[ ... ]

> @@ -79,11 +83,11 @@ SEMANTICS
>  
>  Non-RMW ops:
>  
> -The non-RMW ops are (typically) regular LOADs and STOREs and are canonically
> -implemented using READ_ONCE(), WRITE_ONCE(), smp_load_acquire() and
> -smp_store_release() respectively. Therefore, if you find yourself only using
> -the Non-RMW operations of atomic_t, you do not in fact need atomic_t at all
> -and are doing it wrong.
> +The non-RMW ops are (typically) regular, or conditional LOADs and STOREs and
> +are canonically implemented using READ_ONCE(), WRITE_ONCE(),
> +smp_load_acquire() and smp_store_release() respectively.

[Severity: Low]
This isn't a bug, but does adding "conditional LOADs" here break the 
"respectively" mapping? 

The text continues to list READ_ONCE(), WRITE_ONCE(), smp_load_acquire() and 
smp_store_release() as the canonical implementations, but doesn't add the 
smp_cond_load_* macros to match the newly added conditional LOADs.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260702013334.140905-1-ankur.a.arora@oracle.com?part=7