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] ring-buffer: fix kernel-doc format to avoid a warning
Date: Fri, 17 Oct 2025 00:07:53 -0700 [thread overview]
Message-ID: <20251017070753.1638717-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>
---
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 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--- linux-next-20251016.orig/include/linux/ring_buffer.h
+++ linux-next-20251016/include/linux/ring_buffer.h
@@ -43,7 +43,7 @@ struct ring_buffer_event {
* array[0] = top (28 .. 59) bits
* size = 8 bytes
*
- * <= @RINGBUF_TYPE_DATA_TYPE_LEN_MAX:
+ * @RINGBUF_TYPE_DATA_TYPE_LEN_MAX:
* Data record
* If type_len is zero:
* array[0] holds the actual length
next reply other threads:[~2025-10-17 7:07 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-17 7:07 Randy Dunlap [this message]
2025-10-17 9:08 ` Steven Rostedt
2025-10-17 19:11 ` 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=20251017070753.1638717-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
all inboxes | Powered by JetHome®