| Message ID | 20240519031027.433751-1-marilene.agarcia@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/dp: Fix documentation warning | expand |
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@gmail.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@linaro.org>
On Sun, 19 May 2024 00:10:27 -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' > > [...] Applied, thanks! [1/1] drm/dp: Fix documentation warning commit: c7ce956bb6d0f32ab921b6ffba1a6a834df96f21 Best regards,
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;
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@gmail.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(-)