linux-kernel - Re: [PATCH] drm: Fix documentation warning for read_mpcc

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: <fb2b106e-aa51-4108-9d61-ba71935fba00@amd.com>
Date: Mon, 15 Jul 2024 17:46:38 -0400
From: Aurabindo Pillai <aurabindo.pillai@....com>
To: Abhishek Tamboli <abhishektamboli9@...il.com>, airlied@...il.com,
 daniel@...ll.ch, harry.wentland@....com, sunpeng.li@....com,
 Rodrigo.Siqueira@....com, alexander.deucher@....com,
 christian.koenig@....com, Xinhui.Pan@....com
Cc: amd-gfx@...ts.freedesktop.org, dri-devel@...ts.freedesktop.org,
 linux-kernel@...r.kernel.org, skhan@...uxfoundation.org,
 rbmarliere@...il.com, linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [PATCH] drm: Fix documentation warning for read_mpcc_state in
 mpc.h



On 7/12/24 1:45 PM, Abhishek Tamboli wrote:
> Add detail description for the read_mpcc_state function in the
> mpc_funcs struct to resolve the documentation warning.
> 
> A kernel-doc warning was addressed:
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning:
> Function parameter or struct member 'read_mpcc_state' not
> described in 'mpc_funcs'.
> 
> Signed-off-by: Abhishek Tamboli <abhishektamboli9@...il.com>
> ---
>   drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 16 ++++++++++++++++
>   1 file changed, 16 insertions(+)
> 
> diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> index 34a398f23fc6..9e65ecf1d3b0 100644
> --- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> +++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> @@ -282,6 +282,22 @@ struct mpcc_state {
>    * struct mpc_funcs - funcs
>    */
>   struct mpc_funcs {
> +	/**
> +	 * @read_mpcc_state:
> +	 *
> +	 * Reads the state of a given MPCC instance.
> +	 *
> +	 * Parameters:
> +	 *
> +	 * - [in/out] mpc - MPC context.
> +	 * - [in] mpcc_inst - MPCC Instance whose state is to be read.
> +	 * - [out] mpcc_state - MPCC state structure where the state
> +	 *                    of the MPCC instance will be stored.
> +	 *
> +	 * Return:
> +	 *
> +	 * void
> +	 */
>   	void (*read_mpcc_state)(
>   			struct mpc *mpc,
>   			int mpcc_inst,

Looks like fix for this has been already merged via a195f08636f9d7 
drm/amd/display: fix documentation warnings for mpc.h

--

Thanks & Regards,
Aurabindo Pillai