[PATCH 11/35] powerpc/ps3: Reorganize kerneldoc parameter names

Julia Lawall posted 35 patches 1 month, 4 weeks ago
[PATCH 11/35] powerpc/ps3: Reorganize kerneldoc parameter names
Posted by Julia Lawall 1 month, 4 weeks ago
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>

---
 arch/powerpc/platforms/ps3/interrupt.c  |    2 +-
 arch/powerpc/platforms/ps3/repository.c |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/arch/powerpc/platforms/ps3/interrupt.c b/arch/powerpc/platforms/ps3/interrupt.c
index 49871427f599..af3fe9f04f24 100644
--- a/arch/powerpc/platforms/ps3/interrupt.c
+++ b/arch/powerpc/platforms/ps3/interrupt.c
@@ -378,9 +378,9 @@ int ps3_send_event_locally(unsigned int virq)
 
 /**
  * ps3_sb_event_receive_port_setup - Setup a system bus event receive port.
+ * @dev: The system bus device instance.
  * @cpu: enum ps3_cpu_binding indicating the cpu the interrupt should be
  * serviced on.
- * @dev: The system bus device instance.
  * @virq: The assigned Linux virq.
  *
  * An event irq represents a virtual device interrupt.  The interrupt_id
diff --git a/arch/powerpc/platforms/ps3/repository.c b/arch/powerpc/platforms/ps3/repository.c
index 1abe33fbe529..b8c030eab138 100644
--- a/arch/powerpc/platforms/ps3/repository.c
+++ b/arch/powerpc/platforms/ps3/repository.c
@@ -940,7 +940,7 @@ int __init ps3_repository_read_vuart_sysmgr_port(unsigned int *port)
 
 /**
   * ps3_repository_read_boot_dat_info - Get address and size of cell_ext_os_area.
-  * address: lpar address of cell_ext_os_area
+  * @lpar_addr: lpar address of cell_ext_os_area
   * @size: size of cell_ext_os_area
   */
Re: [PATCH 11/35] powerpc/ps3: Reorganize kerneldoc parameter names
Posted by Geoff Levand 1 month, 3 weeks ago
On 9/30/24 20:20, Julia Lawall 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>
> 
> ---
>  arch/powerpc/platforms/ps3/interrupt.c  |    2 +-
>  arch/powerpc/platforms/ps3/repository.c |    2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)

Looks good. Thanks for your fixes.

Acked-by: Geoff Levand <geoff@infradead.org>
Re: [PATCH 11/35] powerpc/ps3: Reorganize kerneldoc parameter names
Posted by Geert Uytterhoeven 1 month, 4 weeks ago
On Mon, Sep 30, 2024 at 1:24 PM 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>

Reviewed-by: Geert Uytterhoeven <geert@linux-m68k.org>

> --- a/arch/powerpc/platforms/ps3/repository.c
> +++ b/arch/powerpc/platforms/ps3/repository.c
> @@ -940,7 +940,7 @@ int __init ps3_repository_read_vuart_sysmgr_port(unsigned int *port)
>
>  /**
>    * ps3_repository_read_boot_dat_info - Get address and size of cell_ext_os_area.
> -  * address: lpar address of cell_ext_os_area
> +  * @lpar_addr: lpar address of cell_ext_os_area
>    * @size: size of cell_ext_os_area
>    */

Not really a reordering, but good to have it ;-)

Gr{oetje,eeting}s,

                        Geert

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds