From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Steven Rostedt <rostedt@goodmis.org>,
Masami Hiramatsu <mhiramat@kernel.org>,
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
linux-trace-kernel@vger.kernel.org
Subject: [PATCH] tracing: fix trace.h kernel-doc func/struct/enum members
Date: Fri, 10 Jan 2025 22:32:10 -0800 [thread overview]
Message-ID: <20250111063210.910922-1-rdunlap@infradead.org> (raw)
Add missing kernel-doc for function or struct members.
Use the correct enum names for enum members to prevent kernel-doc
warnings.
trace.h:302: warning: Function parameter or struct member 'cond_data' not described in 'cond_snapshot'
trace.h:618: warning: Excess struct member 'print_headers' description in 'tracer'
trace.h:1978: warning: Enum value 'EVENT_CMD_FL_POST_TRIGGER' not described in enum 'event_command_flags'
trace.h:1978: warning: Enum value 'EVENT_CMD_FL_NEEDS_REC' not described in enum 'event_command_flags'
trace.h:1978: warning: Excess enum value 'NEEDS_REC' description in 'event_command_flags'
trace.h:1978: warning: Excess enum value 'POST_TRIGGER' description in 'event_command_flags'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Cc: linux-trace-kernel@vger.kernel.org
---
kernel/trace/trace.h | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
--- linux-next-20250108.orig/kernel/trace/trace.h
+++ linux-next-20250108/kernel/trace/trace.h
@@ -285,6 +285,8 @@ typedef bool (*cond_update_fn_t)(struct
* associated with the trace instance by
* tracing_cond_snapshot_disable().
*
+ * @cond_data: the conditional snapshot's associated data
+ *
* The method below is required.
*
* @update: When a conditional snapshot is invoked, the update()
@@ -568,7 +570,7 @@ struct trace_option_dentry {
* @read: override the default read callback on trace_pipe
* @splice_read: override the default splice_read callback on trace_pipe
* @selftest: selftest to run on boot (see trace_selftest.c)
- * @print_headers: override the first lines that describe your columns
+ * @print_header: override the first lines that describe your columns
* @print_line: callback that prints a trace
* @set_flag: signals one of your private flags changed (trace_options file)
* @flags: your private flags
@@ -1947,7 +1949,7 @@ struct event_command {
/**
* enum event_command_flags - flags for struct event_command
*
- * @POST_TRIGGER: A flag that says whether or not this command needs
+ * @EVENT_CMD_FL_POST_TRIGGER: Indicates whether or not this command needs
* to have its action delayed until after the current event has
* been closed. Some triggers need to avoid being invoked while
* an event is currently in the process of being logged, since
@@ -1966,7 +1968,7 @@ struct event_command {
* itself logs to the trace buffer, this flag should be set,
* otherwise it can be left unspecified.
*
- * @NEEDS_REC: A flag that says whether or not this command needs
+ * @EVENT_CMD_FL_NEEDS_REC: Indicates whether or not this command needs
* access to the trace record in order to perform its function,
* regardless of whether or not it has a filter associated with
* it (filters make a trigger require access to the trace record
next reply other threads:[~2025-01-11 6:32 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-11 6:32 Randy Dunlap [this message]
2025-01-13 21:16 ` [PATCH] tracing: fix trace.h kernel-doc func/struct/enum members Steven Rostedt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250111063210.910922-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mhiramat@kernel.org \
--cc=rostedt@goodmis.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox