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

Zhu Wang posted 1 patch 2 years, 6 months ago
kernel/stacktrace.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH -next] stacktrace: remove kernel-doc warnings
Posted by Zhu Wang 2 years, 6 months ago
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@huawei.com>
---
 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
-- 
2.17.1
Re: [PATCH -next] stacktrace: remove kernel-doc warnings
Posted by Randy Dunlap 2 years, 3 months ago
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@huawei.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.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
Re: [PATCH -next] stacktrace: remove kernel-doc warnings
Posted by Randy Dunlap 2 years, 6 months ago

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@huawei.com>

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

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