Re: [PATCH] tracing: trace_mmap.h: fix a kernel-doc warning
flat view
From: Steven Rostedt <rostedt@goodmis.org>
Date: 2026-01-28 21:43:23
Also in:
lkml
On Tue, 27 Jan 2026 22:25:22 -0800 Randy Dunlap [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Add a description of struct reader to resolve a kernel-doc warning: Warning: include/uapi/linux/trace_mmap.h:43 struct member 'reader' not described in 'trace_buffer_meta' 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 include/uapi/linux/trace_mmap.h | 1 + 1 file changed, 1 insertion(+)--- linux-next-20260126.orig/include/uapi/linux/trace_mmap.h +++ linux-next-20260126/include/uapi/linux/trace_mmap.h@@ -13,6 +13,7 @@ * @reader.lost_events: Number of events lost at the time of the reader swap. * @reader.id: subbuf ID of the current reader. ID range [0 : @nr_subbufs - 1] * @reader.read: Number of bytes read on the reader subbuf. + * @reader: The reader composite info structure
Wouldn't it look better if @reader came before its field descriptions? -- Steve
* @flags: Placeholder for now, 0 until new features are supported. * @entries: Number of entries in the ring-buffer. * @overrun: Number of entries lost in the ring-buffer.