Skip to contentSkip to conversation

notifier: Fix some kernel-doc comments

PATCH Superseded Yang Li 2 participants 2 messages Jan 5, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 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'

---
 kernel/notifier.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
kernel/notifier.c +1 -3
index ba005ebf4730..52b417951c0a 100644
@@ -59,8 +59,6 @@ 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.
  */
 static int notifier_call_chain(struct notifier_block **nl,
 			       unsigned long val, void *v,
@@ -102,7 +100,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
#1 lore raw
Quoted 18 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'

---
 kernel/notifier.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
kernel/notifier.c +0 -0
index ba005ebf4730..52b417951c0a 100644

kernel/notifier.c static int notifier_chain_unregister(struct notifier_block **nl, · line 61

Quoted 3 lines
kernel/notifier.c +0 -0
@@ -59,8 +59,6 @@ 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.

For this one, preferably use:

* Return: the value returned by the last notifier function called.

Quoted 6 lines
kernel/notifier.c +0 -2
- *	@returns:	notifier_call_chain returns the value returned by the
- *			last notifier function called.
  */
 static int notifier_call_chain(struct notifier_block **nl,
 			       unsigned long val, void *v,

kernel/notifier.c NOKPROBE_SYMBOL(notifier_call_chain); · line 106

Quoted 8 lines
kernel/notifier.c +1 -1
@@ -102,7 +100,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

thanks for the patch.

Signature · 1 line
~Randy