Re: [PATCH] ring-buffer: Fix kernel-doc

[Steven Rostedt <rostedt@goodmis.org>]

On Sat,  8 Oct 2022 14:56:24 +0800
Jiapeng Chong <jiapeng.chong@linux.alibaba.com> wrote:

> kernel/trace/ring_buffer.c:895: warning: expecting prototype for ring_buffer_nr_pages_dirty(). Prototype was for ring_buffer_nr_dirty_pages() instead.
> kernel/trace/ring_buffer.c:5313: warning: expecting prototype for ring_buffer_reset_cpu(). Prototype was for ring_buffer_reset_online_cpus() instead.
> kernel/trace/ring_buffer.c:5382: warning: expecting prototype for rind_buffer_empty(). Prototype was for ring_buffer_empty() instead.
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2340
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>
> ---
>  kernel/trace/ring_buffer.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
> index c3f354cfc5ba..89fb203b04b3 100644
> --- a/kernel/trace/ring_buffer.c
> +++ b/kernel/trace/ring_buffer.c
> @@ -885,7 +885,7 @@ size_t ring_buffer_nr_pages(struct trace_buffer *buffer, int cpu)
>  }
>  
>  /**
> - * ring_buffer_nr_pages_dirty - get the number of used pages in the ring buffer
> + * ring_buffer_nr_dirty_pages() - get the number of use_ pages in the ring buffer

Get rid of the parenthesis, that's not how kernel doc works.

-- Steve


>   * @buffer: The ring_buffer to get the number of pages from
>   * @cpu: The cpu of the ring_buffer to get the number of pages from
>   *
> @@ -5305,7 +5305,7 @@ void ring_buffer_reset_cpu(struct trace_buffer *buffer, int cpu)
>  EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
>  
>  /**
> - * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
> + * 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
>   */
> @@ -5375,7 +5375,7 @@ void ring_buffer_reset(struct trace_buffer *buffer)
>  EXPORT_SYMBOL_GPL(ring_buffer_reset);
>  
>  /**
> - * rind_buffer_empty - is the ring buffer empty?
> + * ring_buffer_empty() - is the ring buffer empty?
>   * @buffer: The ring buffer to test
>   */
>  bool ring_buffer_empty(struct trace_buffer *buffer)