[-next,v2] clk: Fix one kernel-doc comment

Message ID 20221122023826.101503-1-yang.lee@linux.alibaba.com
State New
Headers
Series [-next,v2] clk: Fix one kernel-doc comment |

Commit Message

Yang Li Nov. 22, 2022, 2:38 a.m. UTC
  drivers/clk/sunxi-ng/ccu_mmc_timing.c:54: warning: expecting prototype for sunxi_ccu_set_mmc_timing_mode(). Prototype was for sunxi_ccu_get_mmc_timing_mode() instead

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=3230
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---

change in v2:
--According to Randy's suggestion, use the '-' replace ':' to separate function name and description.

 drivers/clk/sunxi-ng/ccu_mmc_timing.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Randy Dunlap Nov. 22, 2022, 4:25 a.m. UTC | #1
Hi--

On 11/21/22 18:38, Yang Li wrote:
> drivers/clk/sunxi-ng/ccu_mmc_timing.c:54: warning: expecting prototype for sunxi_ccu_set_mmc_timing_mode(). Prototype was for sunxi_ccu_get_mmc_timing_mode() instead
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=3230
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

This looks good, although this file needs more work in a few places.

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.


> ---
> 
> change in v2:
> --According to Randy's suggestion, use the '-' replace ':' to separate function name and description.
> 
>  drivers/clk/sunxi-ng/ccu_mmc_timing.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/clk/sunxi-ng/ccu_mmc_timing.c b/drivers/clk/sunxi-ng/ccu_mmc_timing.c
> index de33414fc5c2..88c456a8e49b 100644
> --- a/drivers/clk/sunxi-ng/ccu_mmc_timing.c
> +++ b/drivers/clk/sunxi-ng/ccu_mmc_timing.c
> @@ -43,7 +43,7 @@ int sunxi_ccu_set_mmc_timing_mode(struct clk *clk, bool new_mode)
>  EXPORT_SYMBOL_GPL(sunxi_ccu_set_mmc_timing_mode);
>  
>  /**
> - * sunxi_ccu_set_mmc_timing_mode: Get the current MMC clock timing mode
> + * sunxi_ccu_get_mmc_timing_mode - Get the current MMC clock timing mode
>   * @clk: clock to query
>   *
>   * Returns 0 if the clock is in old timing mode, > 0 if it is in
  
Stephen Boyd Nov. 23, 2022, 1:48 a.m. UTC | #2
Quoting Yang Li (2022-11-21 18:38:26)
> drivers/clk/sunxi-ng/ccu_mmc_timing.c:54: warning: expecting prototype for sunxi_ccu_set_mmc_timing_mode(). Prototype was for sunxi_ccu_get_mmc_timing_mode() instead
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=3230
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---

Reviewed-by: Stephen Boyd <sboyd@kernel.org>
  

Patch

diff --git a/drivers/clk/sunxi-ng/ccu_mmc_timing.c b/drivers/clk/sunxi-ng/ccu_mmc_timing.c
index de33414fc5c2..88c456a8e49b 100644
--- a/drivers/clk/sunxi-ng/ccu_mmc_timing.c
+++ b/drivers/clk/sunxi-ng/ccu_mmc_timing.c
@@ -43,7 +43,7 @@  int sunxi_ccu_set_mmc_timing_mode(struct clk *clk, bool new_mode)
 EXPORT_SYMBOL_GPL(sunxi_ccu_set_mmc_timing_mode);
 
 /**
- * sunxi_ccu_set_mmc_timing_mode: Get the current MMC clock timing mode
+ * sunxi_ccu_get_mmc_timing_mode - Get the current MMC clock timing mode
  * @clk: clock to query
  *
  * Returns 0 if the clock is in old timing mode, > 0 if it is in