]> git.hungrycats.org Git - linux/commitdiff
tracing: Fix ring_buffer_read_page_size() kernel-doc
authorKarl Mehltretter <kmehltretter@gmail.com>
Wed, 9 Sep 2026 06:29:17 +0000 (08:29 +0200)
committerSteven Rostedt <rostedt@goodmis.org>
Fri, 11 Sep 2026 18:04:05 +0000 (14:04 -0400)
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.

Link: https://patch.msgid.link/20260909062917.89482-1-kmehltretter@gmail.com
Fixes: dae8dda341d2 ("tracing: Fix subbuf resize races with trace_pipe_raw readers")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
Reviewed-by: Vincent Donnefort <vdonnefort@google.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
kernel/trace/ring_buffer.c

index 9c03a555a6ba2653eeda213ef2a64200c59fbbff..0e30c7bd60451cb4e0a1da60744945b9d967e2b0 100644 (file)
@@ -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.
  */