sched/wait: Clean up some documentation warnings
authorJonathan Corbet <corbet@lwn.net>
Mon, 24 Jul 2017 19:58:00 +0000 (13:58 -0600)
committerIngo Molnar <mingo@kernel.org>
Tue, 25 Jul 2017 09:17:02 +0000 (11:17 +0200)
commit6c423f5751b9f68bfe7c7545519d4c7159f93e1b
treecb06ed8f1de706ccaa8f094ea31766529648dee5
parentbf50f0e8a03005d19de66d01261d855cdeedf572
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 <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: Ingo Molnar <mingo@kernel.org>
include/linux/wait.h