linux-kernel - Re: [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-prev] [day] [month] [year] [list]

Date: Wed, 3 Apr 2024 23:13:27 +0000
From: "Winiarska, Iwona" <iwona.winiarska@...el.com>
To: "rdunlap@...radead.org" <rdunlap@...radead.org>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
CC: "gregkh@...uxfoundation.org" <gregkh@...uxfoundation.org>,
	"openbmc@...ts.ozlabs.org" <openbmc@...ts.ozlabs.org>
Subject: Re: [PATCH v2] peci: linux/peci.h: fix Excess kernel-doc description
 warning

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@...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?

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