* [PATCH] stacktrace: header: repair kernel-doc comments
@ 2026-07-23 16:18 Randy Dunlap
0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2026-07-23 16:18 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Mark Rutland, Peter Zijlstra, Andrew Morton
- use the "typedef" keyword when describing a typedef
- add a Returns: section
to prevent these kernel-doc warnings:
Warning: include/linux/stacktrace.h:20 function parameter
'stack_trace_consume_fn' not described in 'bool'
Warning: include/linux/stacktrace.h:20 expecting prototype for
stack_trace_consume_fn(). Prototype was for bool() instead
Warning: include/linux/stacktrace.h:58 No description found for
return value of 'arch_stack_walk_reliable'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
include/linux/stacktrace.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
--- linux-next-20260722.orig/include/linux/stacktrace.h
+++ linux-next-20260722/include/linux/stacktrace.h
@@ -11,7 +11,7 @@ struct pt_regs;
#ifdef CONFIG_ARCH_STACKWALK
/**
- * stack_trace_consume_fn - Callback for arch_stack_walk()
+ * typedef stack_trace_consume_fn - Callback for arch_stack_walk()
* @cookie: Caller supplied pointer handed back by arch_stack_walk()
* @addr: The stack entry address to consume
*
@@ -48,9 +48,9 @@ void arch_stack_walk(stack_trace_consume
* @consume_entry
* @task: Pointer to a task struct, can be NULL
*
- * This function returns an error if it detects any unreliable
+ * Returns: a negative error code if it detects any unreliable
* features of the stack. Otherwise it guarantees that the stack
- * trace is reliable.
+ * trace is reliable and returns %0.
*
* If the task is not 'current', the caller *must* ensure the task is
* inactive and its stack is pinned.
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2026-07-23 16:18 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-07-23 16:18 [PATCH] stacktrace: header: repair kernel-doc comments Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®