Skip to content
  • Jonathan Corbet's avatar
    sched/wait: Clean up some documentation warnings · 6c423f57
    Jonathan Corbet authored
    
    
    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: default avatarJonathan Corbet <corbet@lwn.net>
    Cc: Linus Torvalds <torvalds@linux-foundation.org>
    Cc: Peter Zijlstra <peterz@infradead.org>
    Cc: Thomas Gleixner <tglx@linutronix.de>
    Cc: linux-doc@vger.kernel.org
    Link: http://lkml.kernel.org/r/20170724135800.769c4042@lwn.net
    
    
    Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
    6c423f57