Commit d611851b authored by zhangwei(Jovi)'s avatar zhangwei(Jovi) Committed by Steven Rostedt

tracing: Typo fix on ring buffer comments

There have some mismatch between comments with
real function name, update it.

This patch also add some missed function arguments
description.

Link: http://lkml.kernel.org/r/51E3B3B2.4080307@huawei.comSigned-off-by: default avatarzhangwei(Jovi) <jovi.zhangwei@huawei.com>
Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent 146c3442
...@@ -1066,7 +1066,7 @@ static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer, ...@@ -1066,7 +1066,7 @@ static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
} }
/** /**
* check_pages - integrity check of buffer pages * rb_check_pages - integrity check of buffer pages
* @cpu_buffer: CPU buffer with pages to test * @cpu_buffer: CPU buffer with pages to test
* *
* As a safety measure we check to make sure the data pages have not * As a safety measure we check to make sure the data pages have not
...@@ -1258,7 +1258,7 @@ static int rb_cpu_notify(struct notifier_block *self, ...@@ -1258,7 +1258,7 @@ static int rb_cpu_notify(struct notifier_block *self,
#endif #endif
/** /**
* ring_buffer_alloc - allocate a new ring_buffer * __ring_buffer_alloc - allocate a new ring_buffer
* @size: the size in bytes per cpu that is needed. * @size: the size in bytes per cpu that is needed.
* @flags: attributes to set for the ring buffer. * @flags: attributes to set for the ring buffer.
* *
...@@ -1607,6 +1607,7 @@ static void update_pages_handler(struct work_struct *work) ...@@ -1607,6 +1607,7 @@ static void update_pages_handler(struct work_struct *work)
* ring_buffer_resize - resize the ring buffer * ring_buffer_resize - resize the ring buffer
* @buffer: the buffer to resize. * @buffer: the buffer to resize.
* @size: the new size. * @size: the new size.
* @cpu_id: the cpu buffer to resize
* *
* Minimum size is 2 * BUF_PAGE_SIZE. * Minimum size is 2 * BUF_PAGE_SIZE.
* *
...@@ -3956,11 +3957,11 @@ EXPORT_SYMBOL_GPL(ring_buffer_consume); ...@@ -3956,11 +3957,11 @@ EXPORT_SYMBOL_GPL(ring_buffer_consume);
* expected. * expected.
* *
* After a sequence of ring_buffer_read_prepare calls, the user is * After a sequence of ring_buffer_read_prepare calls, the user is
* expected to make at least one call to ring_buffer_prepare_sync. * expected to make at least one call to ring_buffer_read_prepare_sync.
* Afterwards, ring_buffer_read_start is invoked to get things going * Afterwards, ring_buffer_read_start is invoked to get things going
* for real. * for real.
* *
* This overall must be paired with ring_buffer_finish. * This overall must be paired with ring_buffer_read_finish.
*/ */
struct ring_buffer_iter * struct ring_buffer_iter *
ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu) ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
...@@ -4009,7 +4010,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync); ...@@ -4009,7 +4010,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
* an intervening ring_buffer_read_prepare_sync must have been * an intervening ring_buffer_read_prepare_sync must have been
* performed. * performed.
* *
* Must be paired with ring_buffer_finish. * Must be paired with ring_buffer_read_finish.
*/ */
void void
ring_buffer_read_start(struct ring_buffer_iter *iter) ring_buffer_read_start(struct ring_buffer_iter *iter)
...@@ -4031,7 +4032,7 @@ ring_buffer_read_start(struct ring_buffer_iter *iter) ...@@ -4031,7 +4032,7 @@ ring_buffer_read_start(struct ring_buffer_iter *iter)
EXPORT_SYMBOL_GPL(ring_buffer_read_start); EXPORT_SYMBOL_GPL(ring_buffer_read_start);
/** /**
* ring_buffer_finish - finish reading the iterator of the buffer * ring_buffer_read_finish - finish reading the iterator of the buffer
* @iter: The iterator retrieved by ring_buffer_start * @iter: The iterator retrieved by ring_buffer_start
* *
* This re-enables the recording to the buffer, and frees the * This re-enables the recording to the buffer, and frees the
...@@ -4346,6 +4347,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu); ...@@ -4346,6 +4347,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
/** /**
* ring_buffer_alloc_read_page - allocate a page to read from buffer * ring_buffer_alloc_read_page - allocate a page to read from buffer
* @buffer: the buffer to allocate for. * @buffer: the buffer to allocate for.
* @cpu: the cpu buffer to allocate.
* *
* This function is used in conjunction with ring_buffer_read_page. * This function is used in conjunction with ring_buffer_read_page.
* When reading a full page from the ring buffer, these functions * When reading a full page from the ring buffer, these functions
...@@ -4403,7 +4405,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_free_read_page); ...@@ -4403,7 +4405,7 @@ EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
* to swap with a page in the ring buffer. * to swap with a page in the ring buffer.
* *
* for example: * for example:
* rpage = ring_buffer_alloc_read_page(buffer); * rpage = ring_buffer_alloc_read_page(buffer, cpu);
* if (!rpage) * if (!rpage)
* return error; * return error;
* ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0); * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment