+ stacktrace-header-repair-kernel-doc-comments.patch added to mm-nonmm-unstable branch
Andrew Morton <[email protected]>
| Newsgroups | org.kernel.vger.mm-commits |
|---|---|
| Message-ID | <[email protected]> |
The patch titled
Subject: stacktrace: header: repair kernel-doc comments
has been added to the -mm mm-nonmm-unstable branch. Its filename is
stacktrace-header-repair-kernel-doc-comments.patch
This patch will shortly appear at
https://git.kernel.org/pub/scm/linux/kernel/git/akpm/25-new.git/tree/patches/stacktrace-header-repair-kernel-doc-comments.patch
This patch will later appear in the mm-nonmm-unstable branch at
git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next via various
branches at git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm
and is updated there most days
------------------------------------------------------
From: Randy Dunlap <[email protected]>
Subject: stacktrace: header: repair kernel-doc comments
Date: Thu, 23 Jul 2026 09:18:31 -0700
- 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'
Link: https://lore.kernel.org/[email protected]
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Marc Rutland <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
---
include/linux/stacktrace.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
--- a/include/linux/stacktrace.h~stacktrace-header-repair-kernel-doc-comments
+++ a/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.
_
Patches currently in -mm which might be from [email protected] are
mm-migrate-use-migrate_info-field-instead-of-private-fix.patch
mm-page_owner-document-page_owner-filter-fix.patch
radix-tree-add-correct-some-kernel-doc.patch
delaytop-sort-by-max-delay-to-highlight-top-latency-processes-fix.patch
rbtree-fixup-kernel-doc-names.patch
llist-use-correct-function-parameter-name.patch
stacktrace-header-repair-kernel-doc-comments.patch