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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date: Fri, 29 Mar 2024 11:29:10 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Iwona Winiarska <iwona.winiarska@...el.com>,
	openbmc@...ts.ozlabs.org,
	Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Subject: [PATCH v2] peci: linux/peci.h: fix Excess kernel-doc description warning

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@...radead.org>
Cc: Iwona Winiarska <iwona.winiarska@...el.com>
Cc: openbmc@...ts.ozlabs.org
Reviewed-by: Iwona Winiarska <iwona.winiarska@...el.com>
Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.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