Re: [PATCH 7/7] clocksource/drivers/timer-microchip-pit64b: fix compilation warnings

[Daniel Lezcano]

On Tue, Mar 01, 2022 at 02:34:49PM +0200, Claudiu Beznea wrote:
> Fix the following compilation warnings:
> timer-microchip-pit64b.c:68: warning: cannot understand function prototype: 'struct mchp_pit64b_clkevt '
> timer-microchip-pit64b.c:82: warning: cannot understand function prototype: 'struct mchp_pit64b_clksrc '
> timer-microchip-pit64b.c:283: warning: Function parameter or member 'timer' not described in 'mchp_pit64b_init_mode'
> timer-microchip-pit64b.c:283: warning: Function parameter or member 'max_rate' not described in 'mchp_pit64b_init_mode'
> 
> Signed-off-by: Claudiu Beznea <claudiu.beznea@xxxxxxxxxxxxx>
> ---
>  drivers/clocksource/timer-microchip-pit64b.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/clocksource/timer-microchip-pit64b.c b/drivers/clocksource/timer-microchip-pit64b.c
> index f50705698283..5ce206723700 100644
> --- a/drivers/clocksource/timer-microchip-pit64b.c
> +++ b/drivers/clocksource/timer-microchip-pit64b.c
> @@ -46,7 +46,7 @@
>  
>  #define MCHP_PIT64B_NAME		"pit64b"
>  
> -/**

Those are specific for kernel-doc format:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/doc-guide/kernel-doc.rst#n33

You should fix the description format.

> +/*
>   * struct mchp_pit64b_timer - PIT64B timer data structure
>   * @base: base address of PIT64B hardware block
>   * @pclk: PIT64B's peripheral clock
> @@ -60,7 +60,7 @@ struct mchp_pit64b_timer {
>  	u32		mode;
>  };
>  
> -/**
> +/*
>   * mchp_pit64b_clkevt - PIT64B clockevent data structure
>   * @timer: PIT64B timer
>   * @clkevt: clockevent
> @@ -74,7 +74,7 @@ struct mchp_pit64b_clkevt {
>  	((struct mchp_pit64b_timer *)container_of(x,\
>  		struct mchp_pit64b_clkevt, clkevt))
>  
> -/**
> +/*
>   * mchp_pit64b_clksrc - PIT64B clocksource data structure
>   * @timer: PIT64B timer
>   * @clksrc: clocksource
> @@ -244,7 +244,7 @@ static void __init mchp_pit64b_pres_compute(u32 *pres, u32 clk_rate,
>  		*pres = MCHP_PIT64B_PRES_MAX - 1;
>  }
>  
> -/**
> +/*
>   * mchp_pit64b_init_mode - prepare PIT64B mode register value to be used at
>   *			   runtime; this includes prescaler and SGCLK bit
>   *
> -- 
> 2.32.0
> 

-- 

 <http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro:  <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog