Hi, when running 'make htmldocs', Sphinx complains:

WARNING: ./include/drm/drm_connector.h:293 Excess struct member 'mcnmvrr' 
description in 'drm_hdmi_vrr_cap' (did you mean one of: 'cnmvrr', 'cinema_vrr')
WARNING: ./include/drm/drm_connector.h:293 Excess struct member 'mcnmvrr' 
description in 'drm_hdmi_vrr_cap' (did you mean one of: 'cnmvrr', 'cinema_vrr')

Please take a look if I'm doing it correctly. Or if duplicated, please
ignore this.

Also for this file:

WARNING: ./include/drm/drm_connector.h:293 struct member 'cnmvrr' not described 
in 'drm_hdmi_vrr_cap'
WARNING: ./include/drm/drm_connector.h:293 struct member 'cinema_vrr' not 
described in 'drm_hdmi_vrr_cap'
WARNING: ./include/drm/drm_connector.h:293 Excess struct member 'mcnmvrr' 
description in 'drm_hdmi_vrr_cap' (did you mean one of: 'cnmvrr', 'cinema_vrr')
WARNING: ./include/drm/drm_connector.h:293 Excess struct member 'mcinema_vrr' 
description in 'drm_hdmi_vrr_cap' (did you mean one of: 'cinema_vrr', 'cnmvrr')
WARNING: ./include/drm/drm_connector.h:293 struct member 'cnmvrr' not described 
in 'drm_hdmi_vrr_cap'
WARNING: ./include/drm/drm_connector.h:293 struct member 'cinema_vrr' not 
described in 'drm_hdmi_vrr_cap'
WARNING: ./include/drm/drm_connector.h:293 Excess struct member 'mcnmvrr' 
description in 'drm_hdmi_vrr_cap' (did you mean one of: 'cnmvrr', 'cinema_vrr')
WARNING: ./include/drm/drm_connector.h:293 Excess struct member 'mcinema_vrr' 
description in 'drm_hdmi_vrr_cap' (did you mean one of: 'cinema_vrr', 'cnmvrr')

-- >8 --
From: Weijie Yuan <[email protected]>

The HDMI VRR capability comments name mcnmvrr and mcinema_vrr, but
the members are named cnmvrr and cinema_vrr. This causes kernel-doc
to report both missing and excess member descriptions.

Match the comment names to the existing members.

Fixes: 014da1db5e64 ("drm/edid: parse HDMI 2.1 gaming (ALLM/VRR) capabilities 
from HF-VSDB")
Signed-off-by: Weijie Yuan <[email protected]>
---

 include/drm/drm_connector.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index 2ee7c59329aa..bcdb402a7ede 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -265,10 +265,10 @@ struct drm_hdmi_vrr_cap {
        /** @fva: flag for Fast VActive (Quick Frame Transport) support */
        bool fva;
 
-       /** @mcnmvrr: flag for Negative M VRR support */
+       /** @cnmvrr: flag for Negative M VRR support */
        bool cnmvrr;
 
-       /** @mcinema_vrr: flag for Cinema VRR support */
+       /** @cinema_vrr: flag for Cinema VRR support */
        bool cinema_vrr;
 
        /** @mdelta: flag for limited frame-to-frame compensation support */
-- 
2.56.0.438.g30c3f27cb8

Reply via email to