Skip to content

Commit 6c423f5

Browse files
Jonathan CorbetIngo Molnar
authored andcommitted
sched/wait: Clean up some documentation warnings
A couple of kerneldoc comments in <linux/wait.h> had incorrect names for macro parameters, with this unsightly result: ./include/linux/wait.h:555: warning: No description found for parameter 'wq' ./include/linux/wait.h:555: warning: Excess function parameter 'wq_head' description in 'wait_event_interruptible_hrtimeout' ./include/linux/wait.h:759: warning: No description found for parameter 'wq_head' ./include/linux/wait.h:759: warning: Excess function parameter 'wq' description in 'wait_event_killable' Correct the comments and kill the warnings. Signed-off-by: Jonathan Corbet <[email protected]> Cc: Linus Torvalds <[email protected]> Cc: Peter Zijlstra <[email protected]> Cc: Thomas Gleixner <[email protected]> Cc: [email protected] Link: http://lkml.kernel.org/r/[email protected] Signed-off-by: Ingo Molnar <[email protected]>
1 parent bf50f0e commit 6c423f5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/linux/wait.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -529,13 +529,13 @@ do { \
529529

530530
/**
531531
* wait_event_interruptible_hrtimeout - sleep until a condition gets true or a timeout elapses
532-
* @wq_head: the waitqueue to wait on
532+
* @wq: the waitqueue to wait on
533533
* @condition: a C expression for the event to wait for
534534
* @timeout: timeout, as a ktime_t
535535
*
536536
* The process is put to sleep (TASK_INTERRUPTIBLE) until the
537537
* @condition evaluates to true or a signal is received.
538-
* The @condition is checked each time the waitqueue @wq_head is woken up.
538+
* The @condition is checked each time the waitqueue @wq is woken up.
539539
*
540540
* wake_up() has to be called after changing any variable that could
541541
* change the result of the wait condition.
@@ -735,12 +735,12 @@ extern int do_wait_intr_irq(wait_queue_head_t *, wait_queue_entry_t *);
735735

736736
/**
737737
* wait_event_killable - sleep until a condition gets true
738-
* @wq: the waitqueue to wait on
738+
* @wq_head: the waitqueue to wait on
739739
* @condition: a C expression for the event to wait for
740740
*
741741
* The process is put to sleep (TASK_KILLABLE) until the
742742
* @condition evaluates to true or a signal is received.
743-
* The @condition is checked each time the waitqueue @wq is woken up.
743+
* The @condition is checked each time the waitqueue @wq_head is woken up.
744744
*
745745
* wake_up() has to be called after changing any variable that could
746746
* change the result of the wait condition.

0 commit comments

Comments
 (0)