Skip to content

Commit f9b4dc9

Browse files
bulwahnrafaeljw
authored andcommitted
notifier: repair slips in kernel-doc comments
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>
1 parent b7b275e commit f9b4dc9

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

kernel/notifier.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ static int notifier_chain_unregister(struct notifier_block **nl,
6262
* value of this parameter is -1.
6363
* @nr_calls: Records the number of notifications sent. Don't care
6464
* value of this field is NULL.
65-
* @returns: notifier_call_chain returns the value returned by the
65+
* Return: notifier_call_chain returns the value returned by the
6666
* last notifier function called.
6767
*/
6868
static int notifier_call_chain(struct notifier_block **nl,
@@ -105,13 +105,13 @@ NOKPROBE_SYMBOL(notifier_call_chain);
105105
* @val_up: Value passed unmodified to the notifier function
106106
* @val_down: Value passed unmodified to the notifier function when recovering
107107
* from an error on @val_up
108-
* @v Pointer passed unmodified to the notifier function
108+
* @v: Pointer passed unmodified to the notifier function
109109
*
110110
* NOTE: It is important the @nl chain doesn't change between the two
111111
* invocations of notifier_call_chain() such that we visit the
112112
* exact same notifier callbacks; this rules out any RCU usage.
113113
*
114-
* Returns: the return value of the @val_up call.
114+
* Return: the return value of the @val_up call.
115115
*/
116116
static int notifier_call_chain_robust(struct notifier_block **nl,
117117
unsigned long val_up, unsigned long val_down,

0 commit comments

Comments
 (0)