* [PATCH] tracing: Fix ring_buffer_read_page_size() kernel-doc
@ 2026-09-09 6:29 Karl Mehltretter
2026-09-09 6:56 ` Vincent Donnefort
0 siblings, 1 reply; 2+ messages in thread
From: Karl Mehltretter @ 2026-09-09 6:29 UTC (permalink / raw)
To: Steven Rostedt
Cc: Karl Mehltretter, Masami Hiramatsu, Mathieu Desnoyers,
Vincent Donnefort, linux-trace-kernel, linux-kernel
ring_buffer_read_page_size() takes a parameter named rpage, but its
kernel-doc describes page. As a result, kernel-doc reports rpage as
undescribed and page as an excess parameter description.
Rename the documentation entry to match the function.
Fixes: dae8dda341d2 ("tracing: Fix subbuf resize races with trace_pipe_raw readers")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
kernel/trace/ring_buffer.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
index 9c03a555a6ba..0e30c7bd6045 100644
--- a/kernel/trace/ring_buffer.c
+++ b/kernel/trace/ring_buffer.c
@@ -7384,7 +7384,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_read_page_data);
/**
* ring_buffer_read_page_size - get size of the read page.
- * @page: the page to get the size from
+ * @rpage: the page to get the size from
*
* Returns size of the page in bytes.
*/
base-commit: 893e11787f78e43b534e252249ac3fff4d1333f8
--
2.53.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] tracing: Fix ring_buffer_read_page_size() kernel-doc
2026-09-09 6:29 [PATCH] tracing: Fix ring_buffer_read_page_size() kernel-doc Karl Mehltretter
@ 2026-09-09 6:56 ` Vincent Donnefort
0 siblings, 0 replies; 2+ messages in thread
From: Vincent Donnefort @ 2026-09-09 6:56 UTC (permalink / raw)
To: Karl Mehltretter
Cc: Steven Rostedt, Masami Hiramatsu, Mathieu Desnoyers,
linux-trace-kernel, linux-kernel
On Wed, Sep 09, 2026 at 08:29:17AM +0200, Karl Mehltretter wrote:
> ring_buffer_read_page_size() takes a parameter named rpage, but its
> kernel-doc describes page. As a result, kernel-doc reports rpage as
> undescribed and page as an excess parameter description.
>
> Rename the documentation entry to match the function.
>
> Fixes: dae8dda341d2 ("tracing: Fix subbuf resize races with trace_pipe_raw readers")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
> kernel/trace/ring_buffer.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
> index 9c03a555a6ba..0e30c7bd6045 100644
> --- a/kernel/trace/ring_buffer.c
> +++ b/kernel/trace/ring_buffer.c
> @@ -7384,7 +7384,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_read_page_data);
>
> /**
> * ring_buffer_read_page_size - get size of the read page.
> - * @page: the page to get the size from
> + * @rpage: the page to get the size from
> *
> * Returns size of the page in bytes.
> */
>
> base-commit: 893e11787f78e43b534e252249ac3fff4d1333f8
> --
> 2.53.0
Reviewed-by: Vincent Donnefort <vdonnefort@google.com>
--
Vincent
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-09-09 6:56 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-09-09 6:29 [PATCH] tracing: Fix ring_buffer_read_page_size() kernel-doc Karl Mehltretter
2026-09-09 6:56 ` Vincent Donnefort
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®