Re: [PATCH 1/2] clk: samsung: Fix kernel-doc comments

From: Randy Dunlap
Date: Thu Nov 09 2023 - 17:42:30 EST




On 11/9/23 11:09, Sam Protsenko wrote:
> Fix some issues found in kernel-doc comments in Samsung CCF framework.
> It makes scripts/kernel-doc happy, which can be checked with:
>
> $ find drivers/clk/samsung/ -name '*.[ch]' -exec \
> scripts/kernel-doc -v -none {} \;
>
> Signed-off-by: Sam Protsenko <semen.protsenko@xxxxxxxxxx>
> Fixes: ddeac8d968d4 ("clk: samsung: add infrastructure to register cpu clocks")
> Fixes: 721c42a351b1 ("clk: samsung: add common clock framework helper functions for Samsung platforms")
> Fixes: 3ff6e0d8d64d ("clk: samsung: Add support to register rate_table for samsung plls")
> ---
> drivers/clk/samsung/clk-cpu.h | 2 +-
> drivers/clk/samsung/clk.h | 9 ++++++---
> 2 files changed, 7 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/clk/samsung/clk-cpu.h b/drivers/clk/samsung/clk-cpu.h
> index fc9f67a3b22e..103f64193e42 100644
> --- a/drivers/clk/samsung/clk-cpu.h
> +++ b/drivers/clk/samsung/clk-cpu.h
> @@ -11,7 +11,7 @@
> #include "clk.h"
>
> /**
> - * struct exynos_cpuclk_data: config data to setup cpu clocks.
> + * struct exynos_cpuclk_cfg_data: config data to setup cpu clocks.

Hm, OK, the ':' separator works. '-' is the documented separator here,
but it's not worth updating the patch for that.

> * @prate: frequency of the primary parent clock (in KHz).
> * @div0: value to be programmed in the div_cpu0 register.
> * @div1: value to be programmed in the div_cpu1 register.

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

thanks.

--
~Randy