notifier: repair slips in kernel-doc comments
authorLukas Bulwahn <lukas.bulwahn@gmail.com>
Mon, 7 Nov 2022 10:56:57 +0000 (11:56 +0100)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Wed, 30 Nov 2022 18:32:30 +0000 (19:32 +0100)
Invoking ./scripts/kernel-doc -none kernel/notifier.c warns:

  kernel/notifier.c:71: warning: Excess function parameter 'returns' description in 'notifier_call_chain'
  kernel/notifier.c:119: warning: Function parameter or member 'v' not described in 'notifier_call_chain_robust'

These two warning are easy to fix, as they are just due to some minor slips
that makes the comment not follow kernel-doc's syntactic expectation.

Fix those minor slips in kernel-doc comments for make W=1 happiness.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
kernel/notifier.c

index 0d5bd62c480ed3c76c6f3bcc3813f7eabb513aa9..ab75637fd904f7d491a97870ef1f1319c0872407 100644 (file)
@@ -62,7 +62,7 @@ static int notifier_chain_unregister(struct notifier_block **nl,
  *                     value of this parameter is -1.
  *     @nr_calls:      Records the number of notifications sent. Don't care
  *                     value of this field is NULL.
- *     @returns:       notifier_call_chain returns the value returned by the
+ *     Return:         notifier_call_chain returns the value returned by the
  *                     last notifier function called.
  */
 static int notifier_call_chain(struct notifier_block **nl,
@@ -105,13 +105,13 @@ NOKPROBE_SYMBOL(notifier_call_chain);
  * @val_up:    Value passed unmodified to the notifier function
  * @val_down:  Value passed unmodified to the notifier function when recovering
  *              from an error on @val_up
- * @v          Pointer passed unmodified to the notifier function
+ * @v:         Pointer passed unmodified to the notifier function
  *
  * NOTE:       It is important the @nl chain doesn't change between the two
  *             invocations of notifier_call_chain() such that we visit the
  *             exact same notifier callbacks; this rules out any RCU usage.
  *
- * Returns:    the return value of the @val_up call.
+ * Return    the return value of the @val_up call.
  */
 static int notifier_call_chain_robust(struct notifier_block **nl,
                                     unsigned long val_up, unsigned long val_down,