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

Date: Sun, 19 May 2024 00:10:27 -0300
From: MarileneGarcia <marilene.agarcia@...il.com>
To: David Airlie <airlied@...il.com>,
	Daniel Vetter <daniel@...ll.ch>,
	Dmitry Baryshkov <dmitry.baryshkov@...aro.org>,
	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>
Cc: MarileneGarcia <marilene.agarcia@...il.com>,
	Shuah Khan <skhan@...uxfoundation.org>,
	Javier Carrasco <javier.carrasco.cruz@...il.com>,
	dri-devel@...ts.freedesktop.org (open list:DRM DRIVERS),
	linux-kernel@...r.kernel.org (open list)
Subject: [PATCH] drm/dp: Fix documentation warning

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(-)

diff --git a/include/drm/display/drm_dp_helper.h b/include/drm/display/drm_dp_helper.h
index 8bed890eec2c..8defcc399f42 100644
--- a/include/drm/display/drm_dp_helper.h
+++ b/include/drm/display/drm_dp_helper.h
@@ -112,7 +112,7 @@ struct drm_dp_vsc_sdp {
  * @target_rr: Target Refresh
  * @duration_incr_ms: Successive frame duration increase
  * @duration_decr_ms: Successive frame duration decrease
- * @operation_mode: Adaptive Sync Operation Mode
+ * @mode: Adaptive Sync Operation Mode
  */
 struct drm_dp_as_sdp {
 	unsigned char sdp_type;
-- 
2.34.1