Removed controller field description to prevent kernel-doc warnings

[PATCH] Removed controller field description to prevent kernel-doc warnings

Posted by R SUNDAR 2 years, 4 months ago

./include/linux/peci.h:84: warning: Excess struct member 'controller' description in 'peci_device'

Signed-off-by: R SUNDAR <prosunofficial@gmail.com>
---
 include/linux/peci.h | 1 -
 1 file changed, 1 deletion(-)

diff --git a/include/linux/peci.h b/include/linux/peci.h
index 9b3d36aff431..90e241458ef6 100644
--- a/include/linux/peci.h
+++ b/include/linux/peci.h
@@ -58,7 +58,6 @@ static inline struct peci_controller *to_peci_controller(void *d)
 /**
  * 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
-- 
2.34.1

Re: [PATCH] Removed controller field description to prevent kernel-doc warnings

Posted by Randy Dunlap 2 years, 4 months ago


On 3/3/24 05:44, R SUNDAR wrote:
> /include/linux/peci.h:84: warning: Excess struct member 'controller' description in 'peci_device'
> 
> Signed-off-by: R SUNDAR <prosunofficial@gmail.com>

Yes, or
https://lore.kernel.org/lkml/20231223050605.13961-1-rdunlap@infradead.org/

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

> ---
>  include/linux/peci.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/include/linux/peci.h b/include/linux/peci.h
> index 9b3d36aff431..90e241458ef6 100644
> --- a/include/linux/peci.h
> +++ b/include/linux/peci.h
> @@ -58,7 +58,6 @@ static inline struct peci_controller *to_peci_controller(void *d)
>  /**
>   * 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

-- 
#Randy