clk: sunxi: sun9i-cpus: fix kernel-doc warnings

Commit Message

Randy Dunlap Jan. 21, 2024, 5:18 a.m. UTC

Move the function description kernel-doc comment to immediately above
the function implementation, correct the function name in the comment,
then add a function parameter description to prevent these kernel-doc
warnings:

drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead
clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_setup'

Signed-off-by: Randy Dunlap <[e-mail]>
Cc: Emilio López <[e-mail]>
Cc: Michael Turquette <[e-mail]>
Cc: Stephen Boyd <[e-mail]>
Cc: [e-mail]
Cc: Chen-Yu Tsai <[e-mail]>
Cc: Jernej Skrabec <[e-mail]>
Cc: Samuel Holland <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
---
 drivers/clk/sunxi/clk-sun9i-cpus.c |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Andre Przywara Jan. 22, 2024, 10:45 a.m. UTC | #1

On Sat, 20 Jan 2024 21:18:44 -0800
Randy Dunlap <[e-mail]> wrote:

> Move the function description kernel-doc comment to immediately above
> the function implementation, correct the function name in the comment,
> then add a function parameter description to prevent these kernel-doc
> warnings:
> 
> drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead
> clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_setup'

Reviewed-by: Andre Przywara <[e-mail]>

Cheers,
Andre

> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Emilio López <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: Chen-Yu Tsai <[e-mail]>
> Cc: Jernej Skrabec <[e-mail]>
> Cc: Samuel Holland <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> ---
>  drivers/clk/sunxi/clk-sun9i-cpus.c |    7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/clk/sunxi/clk-sun9i-cpus.c b/drivers/clk/sunxi/clk-sun9i-cpus.c
> --- a/drivers/clk/sunxi/clk-sun9i-cpus.c
> +++ b/drivers/clk/sunxi/clk-sun9i-cpus.c
> @@ -18,9 +18,6 @@
>  
>  static DEFINE_SPINLOCK(sun9i_a80_cpus_lock);
>  
> -/**
> - * sun9i_a80_cpus_clk_setup() - Setup function for a80 cpus composite clk
> - */
>  
>  #define SUN9I_CPUS_MAX_PARENTS		4
>  #define SUN9I_CPUS_MUX_PARENT_PLL4	3
> @@ -180,6 +177,10 @@ static const struct clk_ops sun9i_a80_cp
>  	.set_rate	= sun9i_a80_cpus_clk_set_rate,
>  };
>  
> +/**
> + * sun9i_a80_cpus_setup() - Setup function for a80 cpus composite clk
> + * @node: &struct device_node for the clock
> + */
>  static void sun9i_a80_cpus_setup(struct device_node *node)
>  {
>  	const char *clk_name = node->name;
>

Jernej Škrabec Jan. 23, 2024, 5:42 p.m. UTC | #2

Dne nedelja, 21. januar 2024 ob 06:18:44 CET je Randy Dunlap napisal(a):
> Move the function description kernel-doc comment to immediately above
> the function implementation, correct the function name in the comment,
> then add a function parameter description to prevent these kernel-doc
> warnings:
> 
> drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead
> clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_setup'
> 
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Emilio López <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: Chen-Yu Tsai <[e-mail]>
> Cc: Jernej Skrabec <[e-mail]>
> Cc: Samuel Holland <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]

Acked-by: Jernej Skrabec <[e-mail]>

Best regards,
Jernej

Jernej Škrabec Jan. 23, 2024, 8:57 p.m. UTC | #3

Dne nedelja, 21. januar 2024 ob 06:18:44 CET je Randy Dunlap napisal(a):
> Move the function description kernel-doc comment to immediately above
> the function implementation, correct the function name in the comment,
> then add a function parameter description to prevent these kernel-doc
> warnings:
> 
> drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead
> clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_setup'
> 
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Emilio López <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: Chen-Yu Tsai <[e-mail]>
> Cc: Jernej Skrabec <[e-mail]>
> Cc: Samuel Holland <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]

Merged, thanks!

Best regards,
Jernej

Patch

diff -- a/drivers/clk/sunxi/clk-sun9i-cpus.c b/drivers/clk/sunxi/clk-sun9i-cpus.c
--- a/drivers/clk/sunxi/clk-sun9i-cpus.c
+++ b/drivers/clk/sunxi/clk-sun9i-cpus.c
@@ -18,9 +18,6 @@ 
 
 static DEFINE_SPINLOCK(sun9i_a80_cpus_lock);
 
-/**
- * sun9i_a80_cpus_clk_setup() - Setup function for a80 cpus composite clk
- */
 
 #define SUN9I_CPUS_MAX_PARENTS		4
 #define SUN9I_CPUS_MUX_PARENT_PLL4	3
@@ -180,6 +177,10 @@  static const struct clk_ops sun9i_a80_cp
 	.set_rate	= sun9i_a80_cpus_clk_set_rate,
 };
 
+/**
+ * sun9i_a80_cpus_setup() - Setup function for a80 cpus composite clk
+ * @node: &struct device_node for the clock
+ */
 static void sun9i_a80_cpus_setup(struct device_node *node)
 {
 	const char *clk_name = node->name;