drm/dp: fix kernel-doc for struct drm_dp_vsc_sdp
PATCH 1/1 drm/dp: fix kernel-doc for struct drm_dp_vsc_sdp
Add the missing coasting_vtotal kernel-doc member documentation for struct drm_dp_vsc_sdp.
--- include/drm/display/drm_dp_helper.h | 1 + 1 file changed, 1 insertion(+)
include/drm/display/drm_dp_helper.h +1 -0
@@ -115,6 +115,7 @@ struct drm_dp_vsc_sdp {* @duration_decr_ms: Successive frame duration decrease * @target_rr_divider: Target refresh rate divider * @mode: Adaptive Sync Operation Mode +* @coasting_vtotal: Coasting vtotal */ struct drm_dp_as_sdp {unsigned char sdp_type;
Signature · 1 line
2.47.3
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] The commit title and message incorrectly reference `struct drm_dp_vsc_sdp` instead of `struct…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The commit title and message incorrectly reference struct drm_dp_vsc_sdp instead of struct drm_dp_as_sdp. --
commit 8304279d14f731f52c93218e1e0ba5c553ab15f4
Author: Jani Nikula <[email protected]>
drm/dp: fix kernel-doc for struct drm_dp_vsc_sdp
This commit aims to add the missing coasting_vtotal kernel-doc member documentation.
Quoted 4 lines
drm/dp: fix kernel-doc for struct
drm_dp_vsc_sdpAdd the missing
coasting_vtotalkernel-doc member documentation for structdrm_dp_vsc_sdp.
[Severity: Medium]
Are the commit title and message referencing the correct structure?
The commit message states the documentation is being added for struct drm_dp_vsc_sdp, but looking at the diff below, the code modifies the kernel-doc block for struct drm_dp_as_sdp instead.
include/drm/display/drm_dp_helper.h struct drm_dp_vsc_sdp { · line 120
Quoted 10 lines
include/drm/display/drm_dp_helper.h +1
-0@@ -115,6 +115,7 @@ struct drm_dp_vsc_sdp {* @duration_decr_ms: Successive frame duration decrease * @target_rr_divider: Target refresh rate divider * @mode: Adaptive Sync Operation Mode +* @coasting_vtotal: Coasting vtotal */ struct drm_dp_as_sdp {
[Severity: Medium]
Does this coasting_vtotal member belong to struct drm_dp_as_sdp as modified here, or was it intended for struct drm_dp_vsc_sdp?
It appears the git diff hunk header might have misleadingly displayed struct drm_dp_vsc_sdp as the context, while the actual modification is applied to the documentation block for struct drm_dp_as_sdp. Could the commit message be updated to match the code, or was the documentation added to the wrong structure?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Am 15.06.26 um 17:30 schrieb Jani Nikula:
Quoted 4 lines
Add the missing
coasting_vtotalkernel-doc member documentation for structdrm_dp_vsc_sdp.Signed-off-by Jani Nikula <[email protected]>
With the title fixed as mentioned by Sashiko:
Quoted 16 lines
--- include/drm/display/drm_dp_helper.h | 1 + 1 file changed, 1 insertion(+)include/drm/display/drm_dp_helper.h +1
-0@@ -115,6 +115,7 @@ struct drm_dp_vsc_sdp {* @duration_decr_ms: Successive frame duration decrease * @target_rr_divider: Target refresh rate divider * @mode: Adaptive Sync Operation Mode +* @coasting_vtotal: Coasting vtotal */ struct drm_dp_as_sdp {unsigned char sdp_type;
Signature · 6 lines
-- Thomas Zimmermann Graphics Driver Developer SUSE Software Solutions Germany GmbH Frankenstr. 146, 90461 Nürnberg, Germany, www.suse.com GF: Jochen Jaser, Andrew McDonald, Werner Knoblich, (HRB 36809, AG Nürnberg)
Quoted 9 lines · Thomas Zimmermann
Am 15.06.26 um 17:30 schrieb Jani Nikula:
Quoted 4 lines
Add the missing
coasting_vtotalkernel-doc member documentation for structdrm_dp_vsc_sdp.Signed-off-by Jani Nikula <[email protected]>With the title fixed as mentioned by Sashiko:
Reviewed-by Thomas Zimmermann <[email protected]>
Thanks, pushed to drm-misc-fixes with the commit message fixed.
BR,
Jani.
Quoted 17 lines
Quoted 17 lines
--- include/drm/display/drm_dp_helper.h | 1 + 1 file changed, 1 insertion(+)include/drm/display/drm_dp_helper.h +1
-0@@ -115,6 +115,7 @@ struct drm_dp_vsc_sdp {* @duration_decr_ms: Successive frame duration decrease * @target_rr_divider: Target refresh rate divider * @mode: Adaptive Sync Operation Mode +* @coasting_vtotal: Coasting vtotal */ struct drm_dp_as_sdp {unsigned char sdp_type;
Signature · 1 line
Jani Nikula, Intel