Re: [PATCH v2] clk: at91: sama7g5: remove all kernel-doc & kernel-doc warnings

From: Claudiu.Beznea
Date: Fri Aug 20 2021 - 04:19:25 EST


On 20.08.2021 01:32, Randy Dunlap wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
>
> Remove all "/**" kernel-doc markers from sama7g5.c since they are
> all internal to this driver source file only.
> This eliminates 14 warnings that were reported by the kernel test robot.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Cc: Claudiu Beznea <claudiu.beznea@xxxxxxxxxxxxx>
> Cc: Michael Turquette <mturquette@xxxxxxxxxxxx>
> Cc: Stephen Boyd <sboyd@xxxxxxxxxx>
> Cc: Eugen Hristev <eugen.hristev@xxxxxxxxxxxxx>
> Cc: linux-clk@xxxxxxxxxxxxxxx
> Cc: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx

Reviewed-by: Claudiu Beznea <claudiu.beznea@xxxxxxxxxxxxx>

> ---
> v2: use /* instead of /** comments for internal documentation (as
> suggested by Claudiu)
>
> drivers/clk/at91/sama7g5.c | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)
>
> --- linux-next-20210819.orig/drivers/clk/at91/sama7g5.c
> +++ linux-next-20210819/drivers/clk/at91/sama7g5.c
> @@ -35,7 +35,7 @@ static DEFINE_SPINLOCK(pmc_pll_lock);
> static DEFINE_SPINLOCK(pmc_mck0_lock);
> static DEFINE_SPINLOCK(pmc_mckX_lock);
>
> -/**
> +/*
> * PLL clocks identifiers
> * @PLL_ID_CPU: CPU PLL identifier
> * @PLL_ID_SYS: System PLL identifier
> @@ -56,7 +56,7 @@ enum pll_ids {
> PLL_ID_MAX,
> };
>
> -/**
> +/*
> * PLL type identifiers
> * @PLL_TYPE_FRAC: fractional PLL identifier
> * @PLL_TYPE_DIV: divider PLL identifier
> @@ -118,7 +118,7 @@ static const struct clk_pll_characterist
> .output = pll_outputs,
> };
>
> -/**
> +/*
> * PLL clocks description
> * @n: clock name
> * @p: clock parent
> @@ -285,7 +285,7 @@ static const struct {
> },
> };
>
> -/**
> +/*
> * Master clock (MCK[1..4]) description
> * @n: clock name
> * @ep: extra parents names array
> @@ -337,7 +337,7 @@ static const struct {
> .c = 1, },
> };
>
> -/**
> +/*
> * System clock description
> * @n: clock name
> * @p: clock parent name
> @@ -361,7 +361,7 @@ static const struct {
> /* Mux table for programmable clocks. */
> static u32 sama7g5_prog_mux_table[] = { 0, 1, 2, 5, 6, 7, 8, 9, 10, };
>
> -/**
> +/*
> * Peripheral clock description
> * @n: clock name
> * @p: clock parent name
> @@ -449,7 +449,7 @@ static const struct {
> { .n = "uhphs_clk", .p = "mck1", .id = 106, },
> };
>
> -/**
> +/*
> * Generic clock description
> * @n: clock name
> * @pp: PLL parents
>