* [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning
@ 2025-10-20 1:00 Randy Dunlap
2025-10-20 18:33 ` Steven Rostedt
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2025-10-20 1:00 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Lai Jiangshan, Steven Rostedt, Masami Hiramatsu,
Mathieu Desnoyers, linux-trace-kernel
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,
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning
2025-10-20 1:00 [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning Randy Dunlap
@ 2025-10-20 18:33 ` Steven Rostedt
2025-10-20 19:01 ` Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Steven Rostedt @ 2025-10-20 18:33 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Lai Jiangshan, Masami Hiramatsu, Mathieu Desnoyers,
linux-trace-kernel
On Sun, 19 Oct 2025 18:00:37 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:
> 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,
Adding this just to satisfy kerneldoc seems a bit much.
If this is going to be added, then it should be used in the code.
The RINGBUF_TYPE_DATA should probably be called RINGBUF_TYPE_DATA_LARGE, as
it is zero when it is a large event (bigger than 112 bytes).
> RINGBUF_TYPE_DATA_TYPE_LEN_MAX = 28,
> RINGBUF_TYPE_PADDING,
> RINGBUF_TYPE_TIME_EXTEND,
-- Steve
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning
2025-10-20 18:33 ` Steven Rostedt
@ 2025-10-20 19:01 ` Randy Dunlap
0 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2025-10-20 19:01 UTC (permalink / raw)
To: Steven Rostedt
Cc: linux-kernel, Lai Jiangshan, Masami Hiramatsu, Mathieu Desnoyers,
linux-trace-kernel
On 10/20/25 11:33 AM, Steven Rostedt wrote:
> On Sun, 19 Oct 2025 18:00:37 -0700
> Randy Dunlap <rdunlap@infradead.org> wrote:
>
>> 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,
>
> Adding this just to satisfy kerneldoc seems a bit much.
>
> If this is going to be added, then it should be used in the code.
>
> The RINGBUF_TYPE_DATA should probably be called RINGBUF_TYPE_DATA_LARGE, as
> it is zero when it is a large event (bigger than 112 bytes).
>
>> RINGBUF_TYPE_DATA_TYPE_LEN_MAX = 28,
>> RINGBUF_TYPE_PADDING,
>> RINGBUF_TYPE_TIME_EXTEND,
Fine, I'll drop it. :)
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-10-20 19:01 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-20 1:00 [PATCH v2] ring-buffer: fix kernel-doc format to avoid a warning Randy Dunlap
2025-10-20 18:33 ` Steven Rostedt
2025-10-20 19:01 ` Randy Dunlap
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).