notifier: Fix some kernel-doc comments
PATCH v2 1/1 notifier: Fix some kernel-doc comments
Remove some warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'. kernel/notifier.c:68: warning: Excess function parameter 'returns' description in 'notifier_call_chain' kernel/notifier.c:116: warning: Function parameter or member 'v' not described in 'notifier_call_chain_robust'
Reported-by Abaci Robot <[email protected]>
Signed-off-by Yang Li <[email protected]>
--- kernel/notifier.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
kernel/notifier.c +2 -3
@@ -59,8 +59,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 -* last notifier function called. +* Return: the value returned by the last notifier function called. */ static int notifier_call_chain(struct notifier_block **nl, unsigned long val, void *v,
@@ -102,7 +101,7 @@ 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
Signature · 1 line
2.20.1.7.g153144c
Quoted 9 lines · Yang Li
Remove some warnings found by running
scripts/kernel-doc, which is caused by using 'make W=1'.kernel/notifier.c:68: warning: Excess function parameter 'returns' description in 'notifier_call_chain'kernel/notifier.c:116: warning: Function parameter or member 'v' not described in 'notifier_call_chain_robust'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>
Acked-by Randy Dunlap <[email protected]>
Thanks.
Quoted 27 lines
--- kernel/notifier.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)kernel/notifier.c +2
-3@@ -59,8 +59,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 -* last notifier function called. +* Return: the value returned by the last notifier function called. */ static int notifier_call_chain(struct notifier_block **nl, unsigned long val, void *v,@@ -102,7 +101,7 @@ 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
Signature · 1 line
~Randy