Correct or add the missing function parameter kernel-doc comments
to avoid warnings:

Warning: include/asm-generic/futex.h:38 function parameter 'op' not
 described in 'futex_atomic_op_inuser_local'
Warning: include/asm-generic/futex.h:38 function parameter 'oparg' not
 described in 'futex_atomic_op_inuser_local'
Warning: include/asm-generic/futex.h:38 function parameter 'oval' not
 described in 'futex_atomic_op_inuser_local'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: clarify descriptions (André)

Cc: Thomas Gleixner <tglx@kernel.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Darren Hart <dvhart@infradead.org>
Cc: Davidlohr Bueso <dave@stgolabs.net>
Cc: André Almeida <andrealmeid@igalia.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: linux-arch@vger.kernel.org

 include/asm-generic/futex.h |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

--- linux-next-20260227.orig/include/asm-generic/futex.h
+++ linux-next-20260227/include/asm-generic/futex.h
@@ -25,7 +25,9 @@
  *			  argument and comparison of the previous
  *			  futex value with another constant.
  *
- * @encoded_op:	encoded operation to execute
+ * @op:		operation to execute
+ * @oparg:	argument of the operation
+ * @oval:	previous value at @uaddr on successful return
  * @uaddr:	pointer to user space address
  *
  * Return:

Em 03/03/2026 21:50, Randy Dunlap escreveu:
> Correct or add the missing function parameter kernel-doc comments
> to avoid warnings:
> 
> Warning: include/asm-generic/futex.h:38 function parameter 'op' not
>   described in 'futex_atomic_op_inuser_local'
> Warning: include/asm-generic/futex.h:38 function parameter 'oparg' not
>   described in 'futex_atomic_op_inuser_local'
> Warning: include/asm-generic/futex.h:38 function parameter 'oval' not
>   described in 'futex_atomic_op_inuser_local'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: André Almeida <andrealmeid@igalia.com>

The following commit has been merged into the locking/core branch of tip:

Commit-ID:     0da9ca4c08e709144a1bd2f765c14205960ac64d
Gitweb:        https://git.kernel.org/tip/0da9ca4c08e709144a1bd2f765c14205960ac64d
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Tue, 03 Mar 2026 16:50:03 -08:00
Committer:     Peter Zijlstra <peterz@infradead.org>
CommitterDate: Sun, 08 Mar 2026 11:06:47 +01:00

futex: add missing function parameter comments

Correct or add the missing function parameter kernel-doc comments
to avoid warnings:

Warning: include/asm-generic/futex.h:38 function parameter 'op' not
 described in 'futex_atomic_op_inuser_local'
Warning: include/asm-generic/futex.h:38 function parameter 'oparg' not
 described in 'futex_atomic_op_inuser_local'
Warning: include/asm-generic/futex.h:38 function parameter 'oval' not
 described in 'futex_atomic_op_inuser_local'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://patch.msgid.link/20260304005008.409858-1-rdunlap@infradead.org
---
 include/asm-generic/futex.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/asm-generic/futex.h b/include/asm-generic/futex.h
index 2a19215..fbbcfd8 100644
--- a/include/asm-generic/futex.h
+++ b/include/asm-generic/futex.h
@@ -25,7 +25,9 @@
  *			  argument and comparison of the previous
  *			  futex value with another constant.
  *
- * @encoded_op:	encoded operation to execute
+ * @op:		operation to execute
+ * @oparg:	argument of the operation
+ * @oval:	previous value at @uaddr on successful return
  * @uaddr:	pointer to user space address
  *
  * Return: