[PATCH -next] drm/amd/display: fix kernel-doc issues in dc.h

[Alex Deucher]

Applied.  Thanks!

Alex

On Thu, Nov 17, 2022 at 2:39 PM Harry Wentland <harry.wentland at amd.com> wrote:
>
>
>
> On 11/17/22 12:20, Randy Dunlap wrote:
> > Fix these kernel-doc complaints:
> >
> > drivers/gpu/drm/amd/display/dc/dc.h:505: warning: cannot understand function prototype: 'struct dc_clocks '
> > dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID' not described in enum 'pipe_split_policy'
> > dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID_MULT_DISP' not described in enum 'pipe_split_policy'
> > dc.h:532: warning: Incorrect use of kernel-doc format:          * @fw_based_mclk_switching
> >
> > Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
> > Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
> > Signed-off-by: Randy Dunlap <rdunlap at infradead.org>
> > Cc: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>
> > Cc: Alex Deucher <alexander.deucher at amd.com>
> > Cc: Harry Wentland <harry.wentland at amd.com>
> > Cc: Leo Li <sunpeng.li at amd.com>
> > Cc: amd-gfx at lists.freedesktop.org
> > Cc: David Airlie <airlied at gmail.com>
> > Cc: Daniel Vetter <daniel at ffwll.ch>
> > Cc: dri-devel at lists.freedesktop.org
>
> Reviewed-by: Harry Wentland <harry.wentland at amd.com>
>
> Harry
>
> > ---
> >  drivers/gpu/drm/amd/display/dc/dc.h |   12 ++++++------
> >  1 file changed, 6 insertions(+), 6 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
> > @@ -458,15 +458,15 @@ enum pipe_split_policy {
> >       MPC_SPLIT_DYNAMIC = 0,
> >
> >       /**
> > -      * @MPC_SPLIT_DYNAMIC: Avoid pipe split, which means that DC will not
> > +      * @MPC_SPLIT_AVOID: Avoid pipe split, which means that DC will not
> >        * try any sort of split optimization.
> >        */
> >       MPC_SPLIT_AVOID = 1,
> >
> >       /**
> > -      * @MPC_SPLIT_DYNAMIC: With this option, DC will only try to optimize
> > -      * the pipe utilization when using a single display; if the user
> > -      * connects to a second display, DC will avoid pipe split.
> > +      * @MPC_SPLIT_AVOID_MULT_DISP: With this option, DC will only try to
> > +      * optimize the pipe utilization when using a single display; if the
> > +      * user connects to a second display, DC will avoid pipe split.
> >        */
> >       MPC_SPLIT_AVOID_MULT_DISP = 2,
> >  };
> > @@ -497,7 +497,7 @@ enum dcn_zstate_support_state {
> >  };
> >
> >  /**
> > - * dc_clocks - DC pipe clocks
> > + * struct dc_clocks - DC pipe clocks
> >   *
> >   * For any clocks that may differ per pipe only the max is stored in this
> >   * structure
> > @@ -528,7 +528,7 @@ struct dc_clocks {
> >       bool fclk_prev_p_state_change_support;
> >       int num_ways;
> >
> > -     /**
> > +     /*
> >        * @fw_based_mclk_switching
> >        *
> >        * DC has a mechanism that leverage the variable refresh rate to switch
>