History

tracing: trace_mmap.h: fix a kernel-doc warning

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'

Randy Dunlap committed 9 months ago

Commit fd4cb451 parent 6b0c7c21 file · +1 −0Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/linux/trace_mmap.h+1−0
@@ -10,6 +10,7 @@ · 9 unmodified lines
10 * @meta_struct_len: Size of this structure.10 * @meta_struct_len: Size of this structure.
11 * @subbuf_size: Size of each sub-buffer.11 * @subbuf_size: Size of each sub-buffer.
12 * @nr_subbufs: Number of subbfs in the ring-buffer, including the reader.12 * @nr_subbufs: Number of subbfs in the ring-buffer, including the reader.
13 * @reader: The reader composite info structure
13 * @reader.lost_events: Number of events lost at the time of the reader swap.14 * @reader.lost_events: Number of events lost at the time of the reader swap.
14 * @reader.id: subbuf ID of the current reader. ID range [0 : @nr_subbufs - 1]15 * @reader.id: subbuf ID of the current reader. ID range [0 : @nr_subbufs - 1]
15 * @reader.read: Number of bytes read on the reader subbuf.16 * @reader.read: Number of bytes read on the reader subbuf.