]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
tracing: trace_mmap.h: fix a kernel-doc warning
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 29 Jan 2026 01:12:12 +0000 (17:12 -0800)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Tue, 24 Mar 2026 16:19:57 +0000 (12:19 -0400)
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>
Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
include/uapi/linux/trace_mmap.h

index c102ef35d11e408c2193529e21f5d749e62f81ab..99653f259a7a153ae9f002d30396839213a3ea5f 100644 (file)
@@ -10,6 +10,7 @@
  * @meta_struct_len:   Size of this structure.
  * @subbuf_size:       Size of each sub-buffer.
  * @nr_subbufs:                Number of subbfs in the ring-buffer, including the reader.
+ * @reader:            The reader composite info structure
  * @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.