diff mbox series

[21/35] ring-buffer: Reorganize kerneldoc parameter names

Message ID 20240930112121.95324-22-Julia.Lawall@inria.fr (mailing list archive)
State Queued
Headers show
Series Reorganize kerneldoc parameter names | expand

Commit Message

Julia Lawall Sept. 30, 2024, 11:21 a.m. UTC
Reorganize kerneldoc parameter names to match the parameter
order in the function header.

Problems identified using Coccinelle.

Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

---
 kernel/trace/ring_buffer.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Steven Rostedt Sept. 30, 2024, 3:14 p.m. UTC | #1
On Mon, 30 Sep 2024 13:21:07 +0200
Julia Lawall <Julia.Lawall@inria.fr> wrote:

> Reorganize kerneldoc parameter names to match the parameter
> order in the function header.
> 
> Problems identified using Coccinelle.
> 
> Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

-- Steve

> 
> ---
>  kernel/trace/ring_buffer.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
> index 77dc0b25140e..313dffbdeef1 100644
> --- a/kernel/trace/ring_buffer.c
> +++ b/kernel/trace/ring_buffer.c
> @@ -2384,9 +2384,9 @@ EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
>   * __ring_buffer_alloc_range - allocate a new ring_buffer from existing memory
>   * @size: the size in bytes per cpu that is needed.
>   * @flags: attributes to set for the ring buffer.
> + * @order: sub-buffer order
>   * @start: start of allocated range
>   * @range_size: size of allocated range
> - * @order: sub-buffer order
>   * @key: ring buffer reader_lock_key.
>   *
>   * Currently the only flag that is available is the RB_FL_OVERWRITE
Steven Rostedt Oct. 10, 2024, 7:36 p.m. UTC | #2
On Mon, 30 Sep 2024 11:14:31 -0400
Steven Rostedt <rostedt@goodmis.org> wrote:

> On Mon, 30 Sep 2024 13:21:07 +0200
> Julia Lawall <Julia.Lawall@inria.fr> wrote:
> 
> > Reorganize kerneldoc parameter names to match the parameter
> > order in the function header.
> > 
> > Problems identified using Coccinelle.
> > 
> > Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>  
> 
> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

This is part of a series, but do you want me to take it through my tree, or
is this going though another tree?

-- Steve
Julia Lawall Oct. 10, 2024, 7:54 p.m. UTC | #3
On Thu, 10 Oct 2024, Steven Rostedt wrote:

> On Mon, 30 Sep 2024 11:14:31 -0400
> Steven Rostedt <rostedt@goodmis.org> wrote:
>
> > On Mon, 30 Sep 2024 13:21:07 +0200
> > Julia Lawall <Julia.Lawall@inria.fr> wrote:
> >
> > > Reorganize kerneldoc parameter names to match the parameter
> > > order in the function header.
> > >
> > > Problems identified using Coccinelle.
> > >
> > > Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>
> >
> > Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
>
> This is part of a series, but do you want me to take it through my tree, or
> is this going though another tree?

Please take it.  Thanks.

julia

>
> -- Steve
>
diff mbox series

Patch

diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c
index 77dc0b25140e..313dffbdeef1 100644
--- a/kernel/trace/ring_buffer.c
+++ b/kernel/trace/ring_buffer.c
@@ -2384,9 +2384,9 @@  EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
  * __ring_buffer_alloc_range - allocate a new ring_buffer from existing memory
  * @size: the size in bytes per cpu that is needed.
  * @flags: attributes to set for the ring buffer.
+ * @order: sub-buffer order
  * @start: start of allocated range
  * @range_size: size of allocated range
- * @order: sub-buffer order
  * @key: ring buffer reader_lock_key.
  *
  * Currently the only flag that is available is the RB_FL_OVERWRITE