linux-trace-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Lai Jiangshan <laijs@cn.fujitsu.com>,
	Steven Rostedt <rostedt@goodmis.org>,
	Masami Hiramatsu <mhiramat@kernel.org>,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	linux-trace-kernel@vger.kernel.org
Subject: [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning
Date: Sun, 19 Oct 2025 18:00:37 -0700	[thread overview]
Message-ID: <20251020010037.2681824-1-rdunlap@infradead.org> (raw)

Format the kernel-doc for RINGBUF_TYPE_DATA_TYPE_LEN_MAX correctly
to prevent a kernel-doc warning:

Warning: include/linux/ring_buffer.h:61 Enum value
 'RINGBUF_TYPE_DATA_TYPE_LEN_MAX' not described in enum 'ring_buffer_type'

Fixes: 334d4169a659 ("ring_buffer: compressed event header")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: reformat based on comments from Steven;
    add more enum types to aid with comments;

Cc: Lai Jiangshan <laijs@cn.fujitsu.com>
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/linux/ring_buffer.h |   13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

--- linux-next-20251016.orig/include/linux/ring_buffer.h
+++ linux-next-20251016/include/linux/ring_buffer.h
@@ -43,18 +43,23 @@ struct ring_buffer_event {
  *				 array[0] = top (28 .. 59) bits
  *				 size = 8 bytes
  *
- * <= @RINGBUF_TYPE_DATA_TYPE_LEN_MAX:
- *				Data record
- *				 If type_len is zero:
+ * @RINGBUF_TYPE_DATA:		Data record
  *				  array[0] holds the actual length
  *				  array[1..(length+3)/4] holds data
  *				  size = 4 + length (bytes)
- *				 else
+ *
+ * @RINGBUF_TYPE_DATA_TYPE_LEN_MIN:
+ * 				Data record with length and data as below
+ * . . .
+ * @RINGBUF_TYPE_DATA_TYPE_LEN_MAX:
+ *				Data record
  *				  length = type_len << 2
  *				  array[0..(length+3)/4-1] holds data
  *				  size = 4 + length (bytes)
  */
 enum ring_buffer_type {
+	RINGBUF_TYPE_DATA = 0,
+	RINGBUF_TYPE_DATA_TYPE_LEN_MIN = 1,
 	RINGBUF_TYPE_DATA_TYPE_LEN_MAX = 28,
 	RINGBUF_TYPE_PADDING,
 	RINGBUF_TYPE_TIME_EXTEND,

             reply	other threads:[~2025-10-20  1:00 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-20  1:00 Randy Dunlap [this message]
2025-10-20 18:33 ` [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning Steven Rostedt
2025-10-20 19:01   ` Randy Dunlap

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=20251020010037.2681824-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=laijs@cn.fujitsu.com \
    --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;
as well as URLs for NNTP newsgroup(s).