2023-07-31 11:58:05

by wangzhu

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

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 <[email protected]>
---
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

2023-07-31 22:30:24

by Randy Dunlap

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

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 <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

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

2023-10-11 05:02:53

by Randy Dunlap

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 <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

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