[PATCH] fitex: Fix kernel-doc comments

[PATCH] fitex: Fix kernel-doc comments

[Borislav Petkov]

From: "Borislav Petkov (AMD)" <bp@alien8.de>

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'

Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
---
 kernel/futex/futex.h    | 1 +
 kernel/futex/waitwake.c | 5 ++---
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/kernel/futex/futex.h b/kernel/futex/futex.h
index 069fc2a83080..fcd1617212ee 100644
--- a/kernel/futex/futex.h
+++ b/kernel/futex/futex.h
@@ -175,6 +175,7 @@ typedef void (futex_wake_fn)(struct wake_q_head *wake_q, struct futex_q *q);
  * @requeue_pi_key:	the requeue_pi target futex key
  * @bitset:		bitset for the optional bitmasked wakeup
  * @requeue_state:	State field for futex_requeue_pi()
+ * @drop_hb_ref:	Waiter should drop the extra hash bucket reference if true
  * @requeue_wait:	RCU wait for futex_requeue_pi() (RT only)
  *
  * We use this hashed waitqueue, instead of a normal wait_queue_entry_t, so
diff --git a/kernel/futex/waitwake.c b/kernel/futex/waitwake.c
index bd8fef0f8d18..b3738fbe83c6 100644
--- a/kernel/futex/waitwake.c
+++ b/kernel/futex/waitwake.c
@@ -334,8 +334,7 @@ int futex_wake_op(u32 __user *uaddr1, unsigned int flags, u32 __user *uaddr2,
 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() - 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_vector *vs, unsigned int count,
  * @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.
-- 
2.43.0

Re: [PATCH] fitex: Fix kernel-doc comments

[Ingo Molnar]

* Borislav Petkov <bp@kernel.org> wrote:

> From: "Borislav Petkov (AMD)" <bp@alien8.de>
> 
> 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'
> 
> Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>

for the title:

  s/fitex
   /futex

:-)

Please also add:

    Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>

Who also reported it three days ago:

    Link: https://lore.kernel.org/r/20250512185641.0450a99b@canb.auug.org.au

Plus:

    Fixes: 93f1b6d79a73 ("futex: Move futex_queue() into futex_wait_setup()")

With those:

    Acked-by: Ingo Molnar <mingo@kernel.org>

Thanks,

	Ingo

Re: [PATCH] fitex: Fix kernel-doc comments

[Sebastian Andrzej Siewior]

On 2025-05-15 19:16:41 [+0200], Borislav Petkov wrote:
> From: "Borislav Petkov (AMD)" <bp@alien8.de>
> 
> 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'

Thank you. It was on my list for today. Let me fix this up and resend it
(unless you beat me to it).

> Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>

Sebastian