[PATCH] ring-buffer: Remove stale comment from ring_buffer_size()

[PATCH] ring-buffer: Remove stale comment from ring_buffer_size()

[Steven Rostedt]

From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

It's been 11 years since the ring_buffer_size() function was updated to
use the nr_pages from the buffer->buffers[cpu] structure instead of using
the buffer->nr_pages that no longer exists.

The comment in the code is more of what a change log should have and is
pretty much useless for development. It's saying how things worked back in
2012 that bares no purpose on today's code. Remove it.

Link: https://lore.kernel.org/linux-trace-kernel/84d3b41a72bd43dbb9d44921ef535c92@AcuMS.aculab.com/

Reported-by: David Laight <David.Laight@ACULAB.COM>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 kernel/trace/ring_buffer.c | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
index 173d2595ce2d..7887d61d5b56 100644
--- a/kernel/trace/ring_buffer.c
+++ b/kernel/trace/ring_buffer.c
@@ -5122,12 +5122,6 @@ EXPORT_SYMBOL_GPL(ring_buffer_iter_advance);
  */
 unsigned long ring_buffer_size(struct trace_buffer *buffer, int cpu)
 {
-	/*
-	 * Earlier, this method returned
-	 *	buffer->subbuf_size * buffer->nr_pages
-	 * Since the nr_pages field is now removed, we have converted this to
-	 * return the per cpu buffer value.
-	 */
 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
 		return 0;
 
-- 
2.42.0

Re: [PATCH] ring-buffer: Remove stale comment from ring_buffer_size()

[Masami Hiramatsu]

On Wed, 20 Dec 2023 08:10:28 -0500
Steven Rostedt <rostedt@goodmis.org> wrote:

> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 
> It's been 11 years since the ring_buffer_size() function was updated to
> use the nr_pages from the buffer->buffers[cpu] structure instead of using
> the buffer->nr_pages that no longer exists.
> 
> The comment in the code is more of what a change log should have and is
> pretty much useless for development. It's saying how things worked back in
> 2012 that bares no purpose on today's code. Remove it.
> 
> Link: https://lore.kernel.org/linux-trace-kernel/84d3b41a72bd43dbb9d44921ef535c92@AcuMS.aculab.com/
> 

Looks good to me.

Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>

Thanks,

> Reported-by: David Laight <David.Laight@ACULAB.COM>
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> ---
>  kernel/trace/ring_buffer.c | 6 ------
>  1 file changed, 6 deletions(-)
> 
> diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
> index 173d2595ce2d..7887d61d5b56 100644
> --- a/kernel/trace/ring_buffer.c
> +++ b/kernel/trace/ring_buffer.c
> @@ -5122,12 +5122,6 @@ EXPORT_SYMBOL_GPL(ring_buffer_iter_advance);
>   */
>  unsigned long ring_buffer_size(struct trace_buffer *buffer, int cpu)
>  {
> -	/*
> -	 * Earlier, this method returned
> -	 *	buffer->subbuf_size * buffer->nr_pages
> -	 * Since the nr_pages field is now removed, we have converted this to
> -	 * return the per cpu buffer value.
> -	 */
>  	if (!cpumask_test_cpu(cpu, buffer->cpumask))
>  		return 0;
>  
> -- 
> 2.42.0
> 


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>