[PATCH] Fix for kernel doc warning

[PATCH] Fix for kernel doc warning

[R SUNDAR]

[linux-next] Changed enum name to field name to fix kernel doc warning.

./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: R SUNDAR <prosunofficial@gmail.com>
---
 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 baf9949ff96f..6799f57d635c 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

RE: [PATCH] Fix for kernel doc warning

[Golani, Mitulkumar Ajitkumar]

Hi Sundar,

Fix is already floated and reviewed. Looking forward for merge.

https://patchwork.freedesktop.org/series/132061/

Regards,
Mitul

> -----Original Message-----
> From: R SUNDAR <prosunofficial@gmail.com>
> Sent: Saturday, April 6, 2024 3:18 PM
> To: airlied@gmail.com; daniel@ffwll.ch; dmitry.baryshkov@linaro.org;
> Nautiyal, Ankit K <ankit.k.nautiyal@intel.com>; mripard@kernel.org; Nikula,
> Jani <jani.nikula@intel.com>; quic_abhinavk@quicinc.com; Deak, Imre
> <imre.deak@intel.com>; dianders@chromium.org; Golani, Mitulkumar
> Ajitkumar <mitulkumar.ajitkumar.golani@intel.com>
> Cc: dri-devel@lists.freedesktop.org; linux-kernel@vger.kernel.org; R SUNDAR
> <prosunofficial@gmail.com>
> Subject: [PATCH] Fix for kernel doc warning
> 
> [linux-next] Changed enum name to field name to fix kernel doc warning.
> 
> ./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: R SUNDAR <prosunofficial@gmail.com>
> ---
>  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 baf9949ff96f..6799f57d635c 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