]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
sched/wait: correct kernel-doc descriptions
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 2 Mar 2026 00:52:37 +0000 (16:52 -0800)
committerPeter Zijlstra <peterz@infradead.org>
Thu, 12 Mar 2026 06:47:36 +0000 (07:47 +0100)
Use the correct function name and function parameter name to avoid
these kernel-doc warnings:

Warning: include/linux/wait_bit.h:424 expecting prototype for
 wait_var_event_killable(). Prototype was for
 wait_var_event_interruptible() instead
Warning: include/linux/wait_bit.h:508 function parameter 'lock' not
 described in 'wait_var_event_mutex'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://patch.msgid.link/20260302005237.3473095-1-rdunlap@infradead.org
include/linux/wait_bit.h

index 9e29d79fc790affbd9c933915c06803be54cd7ec..ace7379d627d2ac9d108c54ef450e4af81383183 100644 (file)
@@ -406,7 +406,7 @@ do {                                                                        \
                          schedule())
 
 /**
- * wait_var_event_killable - wait for a variable to be updated and notified
+ * wait_var_event_interruptible - wait for a variable to be updated and notified
  * @var: the address of variable being waited on
  * @condition: the condition to wait for
  *
@@ -492,7 +492,7 @@ do {                                                                        \
  * wait_var_event_mutex - wait for a variable to be updated under a mutex
  * @var: the address of the variable being waited on
  * @condition: condition to wait for
- * @mutex: the mutex which protects updates to the variable
+ * @lock: the mutex which protects updates to the variable
  *
  * Wait for a condition which can only be reliably tested while holding
  * a mutex.  The variables assessed in the condition will normal be