ring-buffer: Update the description for ring_buffer_wait

Qiujun Huang · rostedt · commit e1981f75d398 · 2020-10-22T11:26:26.000-04:00
The function changed at some point, but the description was not updated. Link: https://lkml.kernel.org/r/20201017095246.5170-1-hqjagain@gmail.com Signed-off-by: Qiujun Huang <hqjagain@gmail.com> Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
@@ -793,7 +793,7 @@ static void rb_wake_up_waiters(struct irq_work *work)
  * ring_buffer_wait - wait for input to the ring buffer
  * @buffer: buffer to wait on
  * @cpu: the cpu buffer to wait on
- * @full: wait until a full page is available, if @cpu != RING_BUFFER_ALL_CPUS
+ * @full: wait until the percentage of pages are available, if @cpu != RING_BUFFER_ALL_CPUS
  *
  * If @cpu == RING_BUFFER_ALL_CPUS then the task will wake up as soon
  * as data is added to any of the @buffer's cpu buffers. Otherwise

Original file line number	Diff line number	Diff line change
`@@ -793,7 +793,7 @@ static void rb_wake_up_waiters(struct irq_work *work)`
`793`	`793`	`* ring_buffer_wait - wait for input to the ring buffer`
`794`	`794`	`* @buffer: buffer to wait on`
`795`	`795`	`* @cpu: the cpu buffer to wait on`
`796`		`- * @full: wait until a full page is available, if @cpu != RING_BUFFER_ALL_CPUS`
	`796`	`+ * @full: wait until the percentage of pages are available, if @cpu != RING_BUFFER_ALL_CPUS`
`797`	`797`	`*`
`798`	`798`	`* If @cpu == RING_BUFFER_ALL_CPUS then the task will wake up as soon`
`799`	`799`	`* as data is added to any of the @buffer's cpu buffers. Otherwise`