linux-kernel - Re: [PATCH] drm/dp: Fix documentation 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <5e4fs3wjlnqjmbxsu5y5rksqcjvhzwyofhrahvnypbdrgjaf4t@bzm7z4oqvtz4>
Date: Sun, 19 May 2024 12:09:15 +0300
From: Dmitry Baryshkov <dmitry.baryshkov@...aro.org>
To: MarileneGarcia <marilene.agarcia@...il.com>
Cc: David Airlie <airlied@...il.com>, Daniel Vetter <daniel@...ll.ch>, 
	Maxime Ripard <mripard@...nel.org>, Ankit Nautiyal <ankit.k.nautiyal@...el.com>, 
	Imre Deak <imre.deak@...el.com>, Jani Nikula <jani.nikula@...el.com>, 
	Mitul Golani <mitulkumar.ajitkumar.golani@...el.com>, Douglas Anderson <dianders@...omium.org>, 
	Abhinav Kumar <quic_abhinavk@...cinc.com>, Shuah Khan <skhan@...uxfoundation.org>, 
	Javier Carrasco <javier.carrasco.cruz@...il.com>, "open list:DRM DRIVERS" <dri-devel@...ts.freedesktop.org>, 
	open list <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] drm/dp: Fix documentation warning

On Sun, May 19, 2024 at 12:10:27AM -0300, MarileneGarcia wrote:
> It fixes the following warnings when
> the kernel documentation is generated:
> 
> ./include/drm/display/drm_dp_helper.h:126:
> warning: Function parameter or struct member
> 'mode' not described in 'drm_dp_as_sdp'
> 
> ./include/drm/display/drm_dp_helper.h:126:
> warning: Excess struct member 'operation_mode'
> description in 'drm_dp_as_sdp'
> 
> Signed-off-by: MarileneGarcia <marilene.agarcia@...il.com>
> ---
> Changes:
> This documentation comment should refer to the name of the 
> variable to solve the warnings. As operation_mode is the 
> name of the enum, and the declared variable name is mode.
> 
> Thank you.
> 
>  include/drm/display/drm_dp_helper.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 


Fixes: 0bbb8f594e33 ("drm/dp: Add Adaptive Sync SDP logging")
Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@...aro.org>

-- 
With best wishes
Dmitry