[tip: locking/core] futex: add missing function parameter comments

From: tip-bot2 for Randy Dunlap

Date: Mon Mar 09 2026 - 15:50:19 EST


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@xxxxxxxxxxxxx>
AuthorDate: Tue, 03 Mar 2026 16:50:03 -08:00
Committer: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
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@xxxxxxxxxxxxx>
Signed-off-by: Peter Zijlstra (Intel) <peterz@xxxxxxxxxxxxx>
Link: https://patch.msgid.link/20260304005008.409858-1-rdunlap@xxxxxxxxxxxxx
---
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: