Skip to contentSkip to conversation

drm/amd/display: fix documentation warning

PATCH In review Alex Deucher 2 participants 2 messages Oct 24, 2022 – Oct 25, 2022

Subsystems (3)
lore
Share & tools
lore

Alex Deucher

author maintainer
#0 lore raw

PATCH 1/1 drm/amd/display: fix documentation warning

build htmldocs produced this warning:
drivers/gpu/drm/amd/display/dc/dc.h:1275: warning: cannot understand function prototype: 'struct dc_validation_set ' The word "struct" was left out of the comment.

Fixes f4a59996c408 ("drm/amd/display: Include surface of unaffected streams")
Cc Rodrigo Siqueira <[email protected]>
---
 drivers/gpu/drm/amd/display/dc/dc.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/amd/display/dc/dc.h +1 -1
index bd7a896fab49..e4e41f2e5054 100644
@@ -1269,7 +1269,7 @@ void dc_post_update_surfaces_to_stream(
 #include "dc_stream.h"
 
 /**
- * dc_validation_set - Struct to store surface/stream associations for validation
+ * struct dc_validation_set - Struct to store surface/stream associations for validation
  */
 struct dc_validation_set {
 	/**
Signature · 1 line
2.37.3
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · Alex Deucher

build htmldocs produced this warning:
drivers/gpu/drm/amd/display/dc/dc.h:1275: warning: cannot understand function prototype: 'struct dc_validation_set ' The word "struct" was left out of the comment.

Fixes f4a59996c408 ("drm/amd/display: Include surface of unaffected streams")
Cc Rodrigo Siqueira <[email protected]>

Harry

Quoted 17 lines
---
 drivers/gpu/drm/amd/display/dc/dc.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/amd/display/dc/dc.h +1 -1
index bd7a896fab49..e4e41f2e5054 100644
@@ -1269,7 +1269,7 @@ void dc_post_update_surfaces_to_stream(
 #include "dc_stream.h"
 
 /**
- * dc_validation_set - Struct to store surface/stream associations for validation
+ * struct dc_validation_set - Struct to store surface/stream associations for validation
  */
 struct dc_validation_set {
 	/**