linux-kernel - Re: [PATCH -next] stacktrace: remove kernel-doc warnings

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: <5839134f-c430-4a14-8cc4-5c36c30a3891@infradead.org>
Date:   Tue, 10 Oct 2023 22:02:37 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Zhu Wang <wangzhu9@...wei.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next] stacktrace: remove kernel-doc warnings

Hi--

On 7/31/23 04:32, Zhu Wang wrote:
> Remove kernel-doc warnings:
> 
> kernel/stacktrace.c:138: warning: Function parameter or member 'tsk' not
> described in 'stack_trace_save_tsk'
> kernel/stacktrace.c:138: warning: Excess function parameter 'task'
> description in 'stack_trace_save_tsk'
> 
> Signed-off-by: Zhu Wang <wangzhu9@...wei.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Please resend your patch and Cc: Andrew Morton on it
so that it can be merged.

Thanks.

> ---
>  kernel/stacktrace.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/stacktrace.c b/kernel/stacktrace.c
> index 9ed5ce989415..f385f1f54152 100644
> --- a/kernel/stacktrace.c
> +++ b/kernel/stacktrace.c
> @@ -126,7 +126,7 @@ EXPORT_SYMBOL_GPL(stack_trace_save);
>  
>  /**
>   * stack_trace_save_tsk - Save a task stack trace into a storage array
> - * @task:	The task to examine
> + * @tsk:	The task to examine
>   * @store:	Pointer to storage array
>   * @size:	Size of the storage array
>   * @skipnr:	Number of entries to skip at the start of the stack trace

-- 
~Randy