lkml.org 
[lkml]   [2022]   [Jan]   [4]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH -next] notifier: Fix some kernel-doc comments
From


On 1/4/22 17:09, Yang Li wrote:
> 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 <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
> kernel/notifier.c | 4 +---
> 1 file changed, 1 insertion(+), 3 deletions(-)
>
> diff --git a/kernel/notifier.c b/kernel/notifier.c
> index ba005ebf4730..52b417951c0a 100644
> --- a/kernel/notifier.c
> +++ b/kernel/notifier.c
> @@ -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.

> - * @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

thanks for the patch.

--
~Randy

\
 
 \ /
  Last update: 2022-01-05 03:32    [W:0.034 / U:1.356 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site