Re: [PATCH] peci: linux/peci.h: fix Excess kernel-doc description warning

From: Winiarska, Iwona
Date: Wed Jan 10 2024 - 09:20:16 EST


On Fri, 2023-12-22 at 21:06 -0800, Randy Dunlap wrote:
> Remove the @controller: line to prevent the kernel-doc warning:
>
> include/linux/peci.h:84: warning: Excess struct member 'controller'
> description in 'peci_device'
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Iwona Winiarska <iwona.winiarska@xxxxxxxxx>
> Cc: openbmc@xxxxxxxxxxxxxxxx

Reviewed-by: Iwona Winiarska <iwona.winiarska@xxxxxxxxx>

Thanks
-Iwona

> ---
>  include/linux/peci.h |    1 -
>  1 file changed, 1 deletion(-)
>
> diff -- a/include/linux/peci.h b/include/linux/peci.h
> --- a/include/linux/peci.h
> +++ b/include/linux/peci.h
> @@ -58,7 +58,6 @@ static inline struct peci_controller *to
>  /**
>   * struct peci_device - PECI device
>   * @dev: device object to register PECI device to the device model
> - * @controller: manages the bus segment hosting this PECI device
>   * @info: PECI device characteristics
>   * @info.family: device family
>   * @info.model: device model