Skip to content

Commit bd59f61

Browse files
bp3tk0vIngo Molnar
authored andcommitted
futex: Fix kernel-doc comments
Fix those: ./kernel/futex/futex.h:208: warning: Function parameter or struct member 'drop_hb_ref' not described in 'futex_q' ./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' Fixes: 93f1b6d ("futex: Move futex_queue() into futex_wait_setup()") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> Signed-off-by: Ingo Molnar <mingo@kernel.org> Acked-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Peter Zijlstra <peterz@infradead.org> Link: https://lore.kernel.org/r/20250512185641.0450a99b@canb.auug.org.au # report Link: https://lore.kernel.org/r/20250515171641.24073-1-bp@kernel.org # submission
1 parent 094ac8c commit bd59f61

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

kernel/futex/futex.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ typedef void (futex_wake_fn)(struct wake_q_head *wake_q, struct futex_q *q);
175175
* @requeue_pi_key: the requeue_pi target futex key
176176
* @bitset: bitset for the optional bitmasked wakeup
177177
* @requeue_state: State field for futex_requeue_pi()
178+
* @drop_hb_ref: Waiter should drop the extra hash bucket reference if true
178179
* @requeue_wait: RCU wait for futex_requeue_pi() (RT only)
179180
*
180181
* We use this hashed waitqueue, instead of a normal wait_queue_entry_t, so

kernel/futex/waitwake.c

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,7 @@ int futex_wake_op(u32 __user *uaddr1, unsigned int flags, u32 __user *uaddr2,
334334
static long futex_wait_restart(struct restart_block *restart);
335335

336336
/**
337-
* futex_wait_queue() - futex_queue() and wait for wakeup, timeout, or signal
338-
* @hb: the futex hash bucket, must be locked by the caller
337+
* futex_do_wait() - wait for wakeup, timeout, or signal
339338
* @q: the futex_q to queue up on
340339
* @timeout: the prepared hrtimer_sleeper, or null for no timeout
341340
*/
@@ -578,7 +577,7 @@ int futex_wait_multiple(struct futex_vector *vs, unsigned int count,
578577
* @flags: futex flags (FLAGS_SHARED, etc.)
579578
* @q: the associated futex_q
580579
* @key2: the second futex_key if used for requeue PI
581-
* task: Task queueing this futex
580+
* @task: Task queueing this futex
582581
*
583582
* Setup the futex_q and locate the hash_bucket. Get the futex value and
584583
* compare it with the expected value. Handle atomic faults internally.

0 commit comments

Comments
 (0)