[v2] stacktrace: fix kernel-doc typo

Message ID 20231220054945.17663-1-rdunlap@infradead.org
State New
Headers
Series [v2] stacktrace: fix kernel-doc typo |

Commit Message

Randy Dunlap Dec. 20, 2023, 5:49 a.m. UTC
  Change @task to @tsk to prevent kernel-doc warnings:

kernel/stacktrace.c:138: warning: Excess function parameter 'task' description in 'stack_trace_save_tsk'
kernel/stacktrace.c:138: warning: Function parameter or member 'tsk' not described in 'stack_trace_save_tsk'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
---
v2: add Andrew to Cc: list

 kernel/stacktrace.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Patch

diff -- a/kernel/stacktrace.c b/kernel/stacktrace.c
--- 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