[for-next][PATCH 06/13] tracing: trace_mmap.h: fix a kernel-doc warning

Steven Rostedt posted 13 patches 1 week ago
There is a newer version of this series
[for-next][PATCH 06/13] tracing: trace_mmap.h: fix a kernel-doc warning
Posted by Steven Rostedt 1 week ago
From: Randy Dunlap <rdunlap@infradead.org>

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 | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/uapi/linux/trace_mmap.h b/include/uapi/linux/trace_mmap.h
index c102ef35d11e..99653f259a7a 100644
--- a/include/uapi/linux/trace_mmap.h
+++ b/include/uapi/linux/trace_mmap.h
@@ -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.
-- 
2.51.0