diff mbox series

drm/amd/display: dc.h: eliminate kernel-doc warnings

Message ID 20230712022339.17902-1-rdunlap@infradead.org
State New
Headers
Series drm/amd/display: dc.h: eliminate kernel-doc warnings |

Commit Message

Randy Dunlap July 12, 2023, 2:23 a.m. UTC 
  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 <rdunlap@infradead.org>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Cc: Aurabindo Pillai <aurabindo.pillai@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: amd-gfx@lists.freedesktop.org
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
Cc: dri-devel@lists.freedesktop.org
---
 drivers/gpu/drm/amd/display/dc/dc.h |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Harry Wentland July 12, 2023, 1:57 p.m. UTC | #1 
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 <rdunlap@infradead.org>
> Cc: Harry Wentland <harry.wentland@amd.com>
> Cc: Leo Li <sunpeng.li@amd.com>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> Cc: Aurabindo Pillai <aurabindo.pillai@amd.com>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
> Cc: dri-devel@lists.freedesktop.org

Reviewed-by: Harry Wentland <harry.wentland@amd.com>

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];
>
Alex Deucher July 12, 2023, 2:01 p.m. UTC | #2 
Applied.  Thanks!

Alex

On Wed, Jul 12, 2023 at 9:58 AM Harry Wentland <harry.wentland@amd.com> 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 <rdunlap@infradead.org>
> > Cc: Harry Wentland <harry.wentland@amd.com>
> > Cc: Leo Li <sunpeng.li@amd.com>
> > Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > Cc: Aurabindo Pillai <aurabindo.pillai@amd.com>
> > Cc: Alex Deucher <alexander.deucher@amd.com>
> > Cc: amd-gfx@lists.freedesktop.org
> > Cc: Alex Deucher <alexander.deucher@amd.com>
> > Cc: Christian König <christian.koenig@amd.com>
> > Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
> > Cc: dri-devel@lists.freedesktop.org
>
> Reviewed-by: Harry Wentland <harry.wentland@amd.com>
>
> 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];
> >
>
diff mbox series

Patch

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];