summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--include/linux/stacktrace.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/linux/stacktrace.h b/include/linux/stacktrace.h
index 97455880ac41..525cf60673fe 100644
--- a/include/linux/stacktrace.h
+++ b/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_fn consume_entry, void *cookie,
* @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.