Commit 151e34d1 authored by Gaosheng Cui's avatar Gaosheng Cui Committed by Steven Rostedt (Google)
Browse files

ring-buffer: Fix kernel-doc warnings in ring_buffer.c 

Fix kernel-doc warnings:

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

Link: https://lkml.kernel.org/r/20230724140827.1023266-2-cuigaosheng1@huawei.com



Cc: <mhiramat@kernel.org>
Signed-off-by: default avatarGaosheng Cui <cuigaosheng1@huawei.com>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent 2d093282

kernel/trace/ring_buffer.c

+1 −2
Original line number Diff line number Diff line
@@ -950,6 +950,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 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.
@@ -3375,7 +3376,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.

 *
@@ -5358,7 +5358,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)

{