2023-07-12 03:09:45

by Randy Dunlap

Subject: [PATCH] drm/amd/display: dc.h: eliminate kernel-doc warnings

Quash 175 kernel-doc warnings in dc.h by unmarking 2 struct
comments as containing kernel-doc notation and by spelling one
struct field correctly in a kernel-doc comment.

Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
Fixes: f6ae69f49fcf ("drm/amd/display: Include surface of unaffected streams")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Harry Wentland <[email protected]>
Cc: Leo Li <[email protected]>
Cc: Rodrigo Siqueira <[email protected]>
Cc: Aurabindo Pillai <[email protected]>
Cc: Alex Deucher <[email protected]>
Cc: [email protected]
Cc: Alex Deucher <[email protected]>
Cc: Christian König <[email protected]>
Cc: "Pan, Xinhui" <[email protected]>
Cc: [email protected]
---
drivers/gpu/drm/amd/display/dc/dc.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff -- a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
--- a/drivers/gpu/drm/amd/display/dc/dc.h
+++ b/drivers/gpu/drm/amd/display/dc/dc.h
@@ -506,7 +506,7 @@ enum dcn_zstate_support_state {
DCN_ZSTATE_SUPPORT_DISALLOW,
};

-/**
+/*
* struct dc_clocks - DC pipe clocks
*
* For any clocks that may differ per pipe only the max is stored in this
@@ -728,7 +728,7 @@ struct resource_pool;
struct dce_hwseq;
struct link_service;

-/**
+/*
* struct dc_debug_options - DC debug struct
*
* This struct provides a simple mechanism for developers to change some
@@ -756,7 +756,7 @@ struct dc_debug_options {
bool use_max_lb;
enum dcc_option disable_dcc;

- /**
+ /*
* @pipe_split_policy: Define which pipe split policy is used by the
* display core.
*/
@@ -1334,7 +1334,7 @@ struct dc_validation_set {
struct dc_stream_state *stream;

/**
- * @plane_state: Surface state
+ * @plane_states: Surface state
*/
struct dc_plane_state *plane_states[MAX_SURFACES];

2023-07-12 14:06:11

by Harry Wentland

Subject: Re: [PATCH] drm/amd/display: dc.h: eliminate kernel-doc warnings

On 2023-07-11 22:23, Randy Dunlap wrote:
> Quash 175 kernel-doc warnings in dc.h by unmarking 2 struct
> comments as containing kernel-doc notation and by spelling one
> struct field correctly in a kernel-doc comment.
>
> Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
> Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
> Fixes: f6ae69f49fcf ("drm/amd/display: Include surface of unaffected streams")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Harry Wentland <[email protected]>
> Cc: Leo Li <[email protected]>
> Cc: Rodrigo Siqueira <[email protected]>
> Cc: Aurabindo Pillai <[email protected]>
> Cc: Alex Deucher <[email protected]>
> Cc: [email protected]
> Cc: Alex Deucher <[email protected]>
> Cc: Christian König <[email protected]>
> Cc: "Pan, Xinhui" <[email protected]>
> Cc: [email protected]

Reviewed-by: Harry Wentland <[email protected]>

Harry

> ---
> drivers/gpu/drm/amd/display/dc/dc.h | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff -- a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -506,7 +506,7 @@ enum dcn_zstate_support_state {
> DCN_ZSTATE_SUPPORT_DISALLOW,
> };
>
> -/**
> +/*
> * struct dc_clocks - DC pipe clocks
> *
> * For any clocks that may differ per pipe only the max is stored in this
> @@ -728,7 +728,7 @@ struct resource_pool;
> struct dce_hwseq;
> struct link_service;
>
> -/**
> +/*
> * struct dc_debug_options - DC debug struct
> *
> * This struct provides a simple mechanism for developers to change some
> @@ -756,7 +756,7 @@ struct dc_debug_options {
> bool use_max_lb;
> enum dcc_option disable_dcc;
>
> - /**
> + /*
> * @pipe_split_policy: Define which pipe split policy is used by the
> * display core.
> */
> @@ -1334,7 +1334,7 @@ struct dc_validation_set {
> struct dc_stream_state *stream;
>
> /**
> - * @plane_state: Surface state
> + * @plane_states: Surface state
> */
> struct dc_plane_state *plane_states[MAX_SURFACES];
>

2023-07-12 14:07:59

by Alex Deucher

Subject: Re: [PATCH] drm/amd/display: dc.h: eliminate kernel-doc warnings

Applied. Thanks!

Alex

On Wed, Jul 12, 2023 at 9:58 AM Harry Wentland <[email protected]> wrote:
>
> On 2023-07-11 22:23, Randy Dunlap wrote:
> > Quash 175 kernel-doc warnings in dc.h by unmarking 2 struct
> > comments as containing kernel-doc notation and by spelling one
> > struct field correctly in a kernel-doc comment.
> >
> > Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
> > Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
> > Fixes: f6ae69f49fcf ("drm/amd/display: Include surface of unaffected streams")
> > Signed-off-by: Randy Dunlap <[email protected]>
> > Cc: Harry Wentland <[email protected]>
> > Cc: Leo Li <[email protected]>
> > Cc: Rodrigo Siqueira <[email protected]>
> > Cc: Aurabindo Pillai <[email protected]>
> > Cc: Alex Deucher <[email protected]>
> > Cc: [email protected]
> > Cc: Alex Deucher <[email protected]>
> > Cc: Christian König <[email protected]>
> > Cc: "Pan, Xinhui" <[email protected]>
> > Cc: [email protected]
>
> Reviewed-by: Harry Wentland <[email protected]>
>
> Harry
>
> > ---
> > drivers/gpu/drm/amd/display/dc/dc.h | 8 ++++----
> > 1 file changed, 4 insertions(+), 4 deletions(-)
> >
> > diff -- a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> > --- a/drivers/gpu/drm/amd/display/dc/dc.h
> > +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> > @@ -506,7 +506,7 @@ enum dcn_zstate_support_state {
> > DCN_ZSTATE_SUPPORT_DISALLOW,
> > };
> >
> > -/**
> > +/*
> > * struct dc_clocks - DC pipe clocks
> > *
> > * For any clocks that may differ per pipe only the max is stored in this
> > @@ -728,7 +728,7 @@ struct resource_pool;
> > struct dce_hwseq;
> > struct link_service;
> >
> > -/**
> > +/*
> > * struct dc_debug_options - DC debug struct
> > *
> > * This struct provides a simple mechanism for developers to change some
> > @@ -756,7 +756,7 @@ struct dc_debug_options {
> > bool use_max_lb;
> > enum dcc_option disable_dcc;
> >
> > - /**
> > + /*
> > * @pipe_split_policy: Define which pipe split policy is used by the
> > * display core.
> > */
> > @@ -1334,7 +1334,7 @@ struct dc_validation_set {
> > struct dc_stream_state *stream;
> >
> > /**
> > - * @plane_state: Surface state
> > + * @plane_states: Surface state
> > */
> > struct dc_plane_state *plane_states[MAX_SURFACES];
> >
>