linux-kernel - Re: [PATCH -next] notifier: Fix some kernel-doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <94566879-d558-909c-7ba7-fbf944a7427b@infradead.org>
Date:   Tue, 4 Jan 2022 18:30:42 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>, bigeasy@...utronix.de
Cc:     rafael.j.wysocki@...el.com, stern@...land.harvard.edu,
        valentin.schneider@....com, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] notifier: Fix some kernel-doc comments



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@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.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