[PATCH] xtensa: atomics: fix kernel-doc warnings

Randy Dunlap posted 1 patch 6 days, 4 hours ago
arch/xtensa/include/asm/atomic.h |    4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH] xtensa: atomics: fix kernel-doc warnings
Posted by Randy Dunlap 6 days, 4 hours ago
Use the correct function name in kernel-doc comments to avoid
kernel-doc warnings:

Warning: ./arch/xtensa/include/asm/atomic.h:45 expecting prototype for
  atomic_read(). Prototype was for arch_atomic_read() instead
Warning: ./arch/xtensa/include/asm/atomic.h:54 expecting prototype for
  atomic_set(). Prototype was for arch_atomic_set() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Chris Zankel <chris@zankel.net>
Cc: Max Filippov <jcmvbkbc@gmail.com>
Cc: Will Deacon <will@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Boqun Feng <boqun@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Gary Guo <gary@garyguo.net>

 arch/xtensa/include/asm/atomic.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260717.orig/arch/xtensa/include/asm/atomic.h
+++ linux-next-20260717/arch/xtensa/include/asm/atomic.h
@@ -38,7 +38,7 @@
  */
 
 /**
- * atomic_read - read atomic variable
+ * arch_atomic_read - read atomic variable
  * @v: pointer of type atomic_t
  *
  * Atomically reads the value of @v.
@@ -46,7 +46,7 @@
 #define arch_atomic_read(v)		READ_ONCE((v)->counter)
 
 /**
- * atomic_set - set atomic variable
+ * arch_atomic_set - set atomic variable
  * @v: pointer of type atomic_t
  * @i: required value
  *
Re: [PATCH] xtensa: atomics: fix kernel-doc warnings
Posted by Mark Rutland 4 days, 17 hours ago
On Sat, Jul 18, 2026 at 04:08:46PM -0700, Randy Dunlap wrote:
> Use the correct function name in kernel-doc comments to avoid
> kernel-doc warnings:
> 
> Warning: ./arch/xtensa/include/asm/atomic.h:45 expecting prototype for
>   atomic_read(). Prototype was for arch_atomic_read() instead
> Warning: ./arch/xtensa/include/asm/atomic.h:54 expecting prototype for
>   atomic_set(). Prototype was for arch_atomic_set() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

It would be better to delete the comments entirely. We had intended to
do that treewide for arch_atomic*() in commit:

  ef558b4b7bbbf7e1 ("locking/atomic: treewide: delete arch_atomic_*() kerneldoc")

... but evidently missed these by accident.

The intent is that the arch_atomic*() functions are an implementation
detail of the raw_atomic*() API, and aren't supposed to be used
directly. Hence, they shouldn't be documented as generally available.

Thanks,
Mark.

> ---
> Cc: Chris Zankel <chris@zankel.net>
> Cc: Max Filippov <jcmvbkbc@gmail.com>
> Cc: Will Deacon <will@kernel.org>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Boqun Feng <boqun@kernel.org>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Cc: Gary Guo <gary@garyguo.net>
> 
>  arch/xtensa/include/asm/atomic.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux-next-20260717.orig/arch/xtensa/include/asm/atomic.h
> +++ linux-next-20260717/arch/xtensa/include/asm/atomic.h
> @@ -38,7 +38,7 @@
>   */
>  
>  /**
> - * atomic_read - read atomic variable
> + * arch_atomic_read - read atomic variable
>   * @v: pointer of type atomic_t
>   *
>   * Atomically reads the value of @v.
> @@ -46,7 +46,7 @@
>  #define arch_atomic_read(v)		READ_ONCE((v)->counter)
>  
>  /**
> - * atomic_set - set atomic variable
> + * arch_atomic_set - set atomic variable
>   * @v: pointer of type atomic_t
>   * @i: required value
>   *
Re: [PATCH] xtensa: atomics: fix kernel-doc warnings
Posted by Randy Dunlap 4 days, 11 hours ago

On 7/20/26 2:31 AM, Mark Rutland wrote:
> On Sat, Jul 18, 2026 at 04:08:46PM -0700, Randy Dunlap wrote:
>> Use the correct function name in kernel-doc comments to avoid
>> kernel-doc warnings:
>>
>> Warning: ./arch/xtensa/include/asm/atomic.h:45 expecting prototype for
>>   atomic_read(). Prototype was for arch_atomic_read() instead
>> Warning: ./arch/xtensa/include/asm/atomic.h:54 expecting prototype for
>>   atomic_set(). Prototype was for arch_atomic_set() instead
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> 
> It would be better to delete the comments entirely. We had intended to
> do that treewide for arch_atomic*() in commit:
> 

OK, will do.
Thanks.

>   ef558b4b7bbbf7e1 ("locking/atomic: treewide: delete arch_atomic_*() kerneldoc")
> 
> ... but evidently missed these by accident.
> 
> The intent is that the arch_atomic*() functions are an implementation
> detail of the raw_atomic*() API, and aren't supposed to be used
> directly. Hence, they shouldn't be documented as generally available.
> 
> Thanks,
> Mark.
> 
>> ---
>> Cc: Chris Zankel <chris@zankel.net>
>> Cc: Max Filippov <jcmvbkbc@gmail.com>
>> Cc: Will Deacon <will@kernel.org>
>> Cc: Peter Zijlstra <peterz@infradead.org>
>> Cc: Boqun Feng <boqun@kernel.org>
>> Cc: Mark Rutland <mark.rutland@arm.com>
>> Cc: Gary Guo <gary@garyguo.net>
>>
>>  arch/xtensa/include/asm/atomic.h |    4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> --- linux-next-20260717.orig/arch/xtensa/include/asm/atomic.h
>> +++ linux-next-20260717/arch/xtensa/include/asm/atomic.h
>> @@ -38,7 +38,7 @@
>>   */
>>  
>>  /**
>> - * atomic_read - read atomic variable
>> + * arch_atomic_read - read atomic variable
>>   * @v: pointer of type atomic_t
>>   *
>>   * Atomically reads the value of @v.
>> @@ -46,7 +46,7 @@
>>  #define arch_atomic_read(v)		READ_ONCE((v)->counter)
>>  
>>  /**
>> - * atomic_set - set atomic variable
>> + * arch_atomic_set - set atomic variable
>>   * @v: pointer of type atomic_t
>>   * @i: required value
>>   *

-- 
~Randy