[PATCH -next] ring-buffer: remove kernel-doc warnings

[PATCH -next] ring-buffer: remove kernel-doc warnings

[Zhu Wang]

Remove kernel-doc warnings:

kernel/trace/ring_buffer.c:955: warning: Function parameter or member
'cpu' not described in 'ring_buffer_wake_waiters'
kernel/trace/ring_buffer.c:3386: warning: Excess function parameter
'event' description in 'ring_buffer_unlock_commit'
kernel/trace/ring_buffer.c:5362: warning: Excess function parameter 'cpu'
description in 'ring_buffer_reset_online_cpus'

Signed-off-by: Zhu Wang <wangzhu9@huawei.com>
---
 kernel/trace/ring_buffer.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
index de061dd47313..236b6b19dab9 100644
--- a/kernel/trace/ring_buffer.c
+++ b/kernel/trace/ring_buffer.c
@@ -947,6 +947,7 @@ static void rb_wake_up_waiters(struct irq_work *work)
 /**
  * ring_buffer_wake_waiters - wake up any waiters on this ring buffer
  * @buffer: The ring buffer to wake waiters on
+ * @cpu: The cpu of the ring_buffer to wake waiters on
  *
  * In the case of a file that represents a ring buffer is closing,
  * it is prudent to wake up any waiters that are on this.
@@ -3376,7 +3377,6 @@ void ring_buffer_nest_end(struct trace_buffer *buffer)
 /**
  * ring_buffer_unlock_commit - commit a reserved
  * @buffer: The buffer to commit to
- * @event: The event pointer to commit.
  *
  * This commits the data to the ring buffer, and releases any locks held.
  *
@@ -5356,7 +5356,6 @@ EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
 /**
  * ring_buffer_reset_online_cpus - reset a ring buffer per CPU buffer
  * @buffer: The ring buffer to reset a per cpu buffer of
- * @cpu: The CPU buffer to be reset
  */
 void ring_buffer_reset_online_cpus(struct trace_buffer *buffer)
 {
-- 
2.17.1

Re: [PATCH -next] ring-buffer: remove kernel-doc warnings

[Steven Rostedt]

On Mon, 31 Jul 2023 19:31:03 +0800
Zhu Wang <wangzhu9@huawei.com> wrote:

> Remove kernel-doc warnings:
> 
> kernel/trace/ring_buffer.c:955: warning: Function parameter or member
> 'cpu' not described in 'ring_buffer_wake_waiters'
> kernel/trace/ring_buffer.c:3386: warning: Excess function parameter
> 'event' description in 'ring_buffer_unlock_commit'
> kernel/trace/ring_buffer.c:5362: warning: Excess function parameter 'cpu'
> description in 'ring_buffer_reset_online_cpus'
> 
> Signed-off-by: Zhu Wang <wangzhu9@huawei.com>

Gaosheng beat you to it:

  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=151e34d1c6eb2

-- Steve