Re: [PATCH] tracing: Fix ring_buffer_read_page_size() kernel-doc

From: Vincent Donnefort

Date: Wed Sep 09 2026 - 03:01:06 EST


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@xxxxxxxxx>
> ---
> 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@xxxxxxxxxx>

--
Vincent