[PATCH] futex: fix waitwake kernel-doc warnings
From: Randy Dunlap
Date: Mon May 19 2025 - 17:15:04 EST
Match a function comment to the actual function name. [futex_do_wait()]
Drop the kernel-doc for a removed function parameter. [@hb]
Use @task: for a function parameter description. [futex_wait_setup()]
kernel/futex/waitwake.c:343: warning: expecting prototype for futex_wait_queue(). Prototype was for futex_do_wait() instead
kernel/futex/waitwake.c:594: warning: Function parameter or struct member 'task' not described in 'futex_wait_setup'
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Cc: Ingo Molnar <mingo@xxxxxxxxxx>
Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
---
kernel/futex/waitwake.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
--- linux-next-20250516.orig/kernel/futex/waitwake.c
+++ linux-next-20250516/kernel/futex/waitwake.c
@@ -334,8 +334,7 @@ out_unlock:
static long futex_wait_restart(struct restart_block *restart);
/**
- * futex_wait_queue() - futex_queue() and wait for wakeup, timeout, or signal
- * @hb: the futex hash bucket, must be locked by the caller
+ * futex_do_wait() - futex_queue() and wait for wakeup, timeout, or signal
* @q: the futex_q to queue up on
* @timeout: the prepared hrtimer_sleeper, or null for no timeout
*/
@@ -578,7 +577,7 @@ int futex_wait_multiple(struct futex_vec
* @flags: futex flags (FLAGS_SHARED, etc.)
* @q: the associated futex_q
* @key2: the second futex_key if used for requeue PI
- * task: Task queueing this futex
+ * @task: Task queueing this futex
*
* Setup the futex_q and locate the hash_bucket. Get the futex value and
* compare it with the expected value. Handle atomic faults internally.