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

Randy Dunlap rdunlap at infradead.org
Sat Mar 30 05:29:10 AEDT 2024


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 at infradead.org>
Cc: Iwona Winiarska <iwona.winiarska at intel.com>
Cc: openbmc at lists.ozlabs.org
Reviewed-by: Iwona Winiarska <iwona.winiarska at intel.com>
Cc: Greg Kroah-Hartman <gregkh at 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


More information about the openbmc mailing list