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

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

Posted by Randy Dunlap 2 years ago

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@infradead.org>
Cc: Iwona Winiarska <iwona.winiarska@intel.com>
Cc: openbmc@lists.ozlabs.org
---
 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

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

Posted by Winiarska, Iwona 1 year, 11 months ago

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@infradead.org>
> Cc: Iwona Winiarska <iwona.winiarska@intel.com>
> Cc: openbmc@lists.ozlabs.org

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

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

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

Posted by Randy Dunlap 1 year, 9 months ago


On 1/10/24 06:19, Winiarska, Iwona wrote:
> 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@infradead.org>
>> Cc: Iwona Winiarska <iwona.winiarska@intel.com>
>> Cc: openbmc@lists.ozlabs.org
> 
> Reviewed-by: Iwona Winiarska <iwona.winiarska@intel.com>
> 
> Thanks
> -Iwona

Hi Iwona,

Who should be merging this patch?

Thanks.

> 
>> ---
>>  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
> 

-- 
#Randy