linux-kernel - Re: [PATCH] firmware: arm_scmi: optee: fix struct kernel-doc warnings

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZdXV8Tlig2qeIGD2@pluto>
Date: Wed, 21 Feb 2024 10:52:33 +0000
From: Cristian Marussi <cristian.marussi@....com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Sudeep Holla <sudeep.holla@....com>,
	linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH] firmware: arm_scmi: optee: fix struct kernel-doc warnings

On Tue, Feb 20, 2024 at 10:21:57PM -0800, Randy Dunlap wrote:
> Fix the kernel-doc notation for the nested union in struct
> scmi_optee_channel to eliminate kerenl-doc warnings:
> 
> optee.c:130: warning: Excess struct member 'shmem' description in 'scmi_optee_channel'
> optee.c:131: warning: Function parameter or struct member 'req' not described in 'scmi_optee_channel'

Thanks for this, I've spotted it recently and didn't get time to address it.

Reviewed-by: Cristian Marussi <cristian.marussi@....com>

Cristian

> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Sudeep Holla <sudeep.holla@....com>
> Cc: Cristian Marussi <cristian.marussi@....com>
> Cc: linux-arm-kernel@...ts.infradead.org
> ---
>  drivers/firmware/arm_scmi/optee.c |    6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff -- a/drivers/firmware/arm_scmi/optee.c b/drivers/firmware/arm_scmi/optee.c
> --- a/drivers/firmware/arm_scmi/optee.c
> +++ b/drivers/firmware/arm_scmi/optee.c
> @@ -109,8 +109,10 @@ enum scmi_optee_pta_cmd {
>   * @rx_len: Response size
>   * @mu: Mutex protection on channel access
>   * @cinfo: SCMI channel information
> - * @shmem: Virtual base address of the shared memory
> - * @req: Shared memory protocol handle for SCMI request and synchronous response
> + * @req: union for SCMI interface
> + * @req.shmem: Virtual base address of the shared memory
> + * @req.msg: Shared memory protocol handle for SCMI request and
> + *   synchronous response
>   * @tee_shm: TEE shared memory handle @req or NULL if using IOMEM shmem
>   * @link: Reference in agent's channel list
>   */