linux-kernel - Re: [PATCH -next] drm/amd/display: fix kernel-doc issues in dc.h

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 for Android: free password hash cracker in your pocket

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

Message-ID: <28960f0b-97b9-7a41-9da3-188be25dd886@amd.com>
Date:   Thu, 17 Nov 2022 14:39:46 -0500
From:   Harry Wentland <harry.wentland@....com>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc:     Rodrigo Siqueira <Rodrigo.Siqueira@....com>,
        Alex Deucher <alexander.deucher@....com>,
        Leo Li <sunpeng.li@....com>, amd-gfx@...ts.freedesktop.org,
        David Airlie <airlied@...il.com>,
        Daniel Vetter <daniel@...ll.ch>,
        dri-devel@...ts.freedesktop.org
Subject: Re: [PATCH -next] drm/amd/display: fix kernel-doc issues in dc.h



On 11/17/22 12:20, Randy Dunlap wrote:
> Fix these kernel-doc complaints:
> 
> drivers/gpu/drm/amd/display/dc/dc.h:505: warning: cannot understand function prototype: 'struct dc_clocks '
> dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID' not described in enum 'pipe_split_policy'
> dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID_MULT_DISP' not described in enum 'pipe_split_policy'
> dc.h:532: warning: Incorrect use of kernel-doc format:          * @fw_based_mclk_switching
> 
> Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
> Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@....com>
> Cc: Alex Deucher <alexander.deucher@....com>
> Cc: Harry Wentland <harry.wentland@....com>
> Cc: Leo Li <sunpeng.li@....com>
> Cc: amd-gfx@...ts.freedesktop.org
> Cc: David Airlie <airlied@...il.com>
> Cc: Daniel Vetter <daniel@...ll.ch>
> Cc: dri-devel@...ts.freedesktop.org

Reviewed-by: Harry Wentland <harry.wentland@....com>

Harry

> ---
>  drivers/gpu/drm/amd/display/dc/dc.h |   12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff -- a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -458,15 +458,15 @@ enum pipe_split_policy {
>  	MPC_SPLIT_DYNAMIC = 0,
>  
>  	/**
> -	 * @MPC_SPLIT_DYNAMIC: Avoid pipe split, which means that DC will not
> +	 * @MPC_SPLIT_AVOID: Avoid pipe split, which means that DC will not
>  	 * try any sort of split optimization.
>  	 */
>  	MPC_SPLIT_AVOID = 1,
>  
>  	/**
> -	 * @MPC_SPLIT_DYNAMIC: With this option, DC will only try to optimize
> -	 * the pipe utilization when using a single display; if the user
> -	 * connects to a second display, DC will avoid pipe split.
> +	 * @MPC_SPLIT_AVOID_MULT_DISP: With this option, DC will only try to
> +	 * optimize the pipe utilization when using a single display; if the
> +	 * user connects to a second display, DC will avoid pipe split.
>  	 */
>  	MPC_SPLIT_AVOID_MULT_DISP = 2,
>  };
> @@ -497,7 +497,7 @@ enum dcn_zstate_support_state {
>  };
>  
>  /**
> - * dc_clocks - DC pipe clocks
> + * struct dc_clocks - DC pipe clocks
>   *
>   * For any clocks that may differ per pipe only the max is stored in this
>   * structure
> @@ -528,7 +528,7 @@ struct dc_clocks {
>  	bool fclk_prev_p_state_change_support;
>  	int num_ways;
>  
> -	/**
> +	/*
>  	 * @fw_based_mclk_switching
>  	 *
>  	 * DC has a mechanism that leverage the variable refresh rate to switch