[13/20] clk: ti: clockdomain: Fix description for 'omap2_init_clk_clkdm's hw param

Commit Message

Lee Jones Jan. 20, 2021, 9:30 a.m. UTC

Fixes the following W=1 kernel build warning(s):

 drivers/clk/ti/clockdomain.c:107: warning: Function parameter or member 'hw' not described in 'omap2_init_clk_clkdm'
 drivers/clk/ti/clockdomain.c:107: warning: Excess function parameter 'clk' description in 'omap2_init_clk_clkdm'

Cc: Tero Kristo <[e-mail]>
Cc: Michael Turquette <[e-mail]>
Cc: Stephen Boyd <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
Signed-off-by: Lee Jones <[e-mail]>
---
 drivers/clk/ti/clockdomain.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Tero Kristo Jan. 20, 2021, 11:27 a.m. UTC | #1

On 20/01/2021 11:30, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>   drivers/clk/ti/clockdomain.c:107: warning: Function parameter or member 'hw' not described in 'omap2_init_clk_clkdm'
>   drivers/clk/ti/clockdomain.c:107: warning: Excess function parameter 'clk' description in 'omap2_init_clk_clkdm'
> 
> Cc: Tero Kristo <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> Signed-off-by: Lee Jones <[e-mail]>

Reviewed-by: Tero Kristo <[e-mail]>

> ---
>   drivers/clk/ti/clockdomain.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/clk/ti/clockdomain.c b/drivers/clk/ti/clockdomain.c
> index 700b7f44f6716..74831b2752b3b 100644
> --- a/drivers/clk/ti/clockdomain.c
> +++ b/drivers/clk/ti/clockdomain.c
> @@ -97,7 +97,7 @@ void omap2_clkops_disable_clkdm(struct clk_hw *hw)
>   
>   /**
>    * omap2_init_clk_clkdm - look up a clockdomain name, store pointer in clk
> - * @clk: OMAP clock struct ptr to use
> + * @hw: Pointer to clk_hw_omap used to obtain OMAP clock struct ptr to use
>    *
>    * Convert a clockdomain name stored in a struct clk 'clk' into a
>    * clockdomain pointer, and save it into the struct clk.  Intended to be
>

Stephen Boyd Feb. 11, 2021, 7:52 p.m. UTC | #2

Quoting Lee Jones (2021-01-20 01:30:33)
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/clk/ti/clockdomain.c:107: warning: Function parameter or member 'hw' not described in 'omap2_init_clk_clkdm'
>  drivers/clk/ti/clockdomain.c:107: warning: Excess function parameter 'clk' description in 'omap2_init_clk_clkdm'
> 
> Cc: Tero Kristo <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> Signed-off-by: Lee Jones <[e-mail]>
> ---

Applied to clk-next

Patch

diff --git a/drivers/clk/ti/clockdomain.c b/drivers/clk/ti/clockdomain.c
index 700b7f44f6716..74831b2752b3b 100644
--- a/drivers/clk/ti/clockdomain.c
+++ b/drivers/clk/ti/clockdomain.c
@@ -97,7 +97,7 @@  void omap2_clkops_disable_clkdm(struct clk_hw *hw)
 
 /**
  * omap2_init_clk_clkdm - look up a clockdomain name, store pointer in clk
- * @clk: OMAP clock struct ptr to use
+ * @hw: Pointer to clk_hw_omap used to obtain OMAP clock struct ptr to use
  *
  * Convert a clockdomain name stored in a struct clk 'clk' into a
  * clockdomain pointer, and save it into the struct clk.  Intended to be