linux-kernel - Re: [PATCH] clk: sunxi: sun9i-cpus: fix kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240122104504.1f84ed98@donnerap.manchester.arm.com>
Date: Mon, 22 Jan 2024 10:45:04 +0000
From: Andre Przywara <andre.przywara@....com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Emilio López
 <emilio@...pez.com.ar>, Michael Turquette <mturquette@...libre.com>,
 Stephen Boyd <sboyd@...nel.org>, linux-clk@...r.kernel.org, Chen-Yu Tsai
 <wens@...e.org>, Jernej Skrabec <jernej.skrabec@...il.com>, Samuel Holland
 <samuel@...lland.org>, linux-arm-kernel@...ts.infradead.org,
 linux-sunxi@...ts.linux.dev
Subject: Re: [PATCH] clk: sunxi: sun9i-cpus: fix kernel-doc warnings

On Sat, 20 Jan 2024 21:18:44 -0800
Randy Dunlap <rdunlap@...radead.org> 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 <andre.przywara@....com>

Cheers,
Andre

> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Emilio López <emilio@...pez.com.ar>
> Cc: Michael Turquette <mturquette@...libre.com>
> Cc: Stephen Boyd <sboyd@...nel.org>
> Cc: linux-clk@...r.kernel.org
> Cc: Chen-Yu Tsai <wens@...e.org>
> Cc: Jernej Skrabec <jernej.skrabec@...il.com>
> Cc: Samuel Holland <samuel@...lland.org>
> Cc: linux-arm-kernel@...ts.infradead.org
> Cc: linux-sunxi@...ts.linux.dev
> ---
>  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;
>