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

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

[Randy Dunlap]

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>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
v2: add Rev-by, add gregkh email

Would it make sense to add Greg as M: in the MAINTAINERS file?
How does someone know to Cc: Greg on PECI patches?

 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 v2] peci: linux/peci.h: fix Excess kernel-doc description warning

[Winiarska, Iwona]

On Fri, 2024-03-29 at 11:29 -0700, 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>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> ---
> v2: add Rev-by, add gregkh email
> 
> Would it make sense to add Greg as M: in the MAINTAINERS file?
> How does someone know to Cc: Greg on PECI patches?

Hi Randy,

Normally I was taking PECI related patches into peci-next [1] and sending a PR
to Greg. Unfortunately, I didn't manage to send it in v6.9 cycle, which is why
your patch didn't land in mainline yet. Sorry about that delay.

[1] https://git.kernel.org/pub/scm/linux/kernel/git/iwi/linux.git/log/?h=peci-next

-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