2024-04-06 09:48:26

by R Sundar

[permalink] [raw]
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 <[email protected]>
---
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



Subject: RE: [PATCH] Fix for kernel doc warning

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 <[email protected]>
> Sent: Saturday, April 6, 2024 3:18 PM
> To: [email protected]; [email protected]; [email protected];
> Nautiyal, Ankit K <[email protected]>; [email protected]; Nikula,
> Jani <[email protected]>; [email protected]; Deak, Imre
> <[email protected]>; [email protected]; Golani, Mitulkumar
> Ajitkumar <[email protected]>
> Cc: [email protected]; [email protected]; R SUNDAR
> <[email protected]>
> 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 <[email protected]>
> ---
> 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