[Intel-gfx] [PATCH] drm/i915/display: Squelch kerneldoc complaints

[Jani Nikula]

On Sun, 26 Jan 2020, Chris Wilson <chris at chris-wilson.co.uk> wrote:
> drivers/gpu/drm/i915/display/intel_atomic.c:185: warning: Function parameter or member 'state' not described in 'intel_connector_needs_modeset'
> drivers/gpu/drm/i915/display/intel_atomic.c:185: warning: Function parameter or member 'connector' not described in 'intel_connector_needs_modeset'
>
> drivers/gpu/drm/i915/display/intel_fbc.c:1124: warning: Function parameter or member 'state' not described in 'intel_fbc_enable'
> drivers/gpu/drm/i915/display/intel_fbc.c:1124: warning: Excess function parameter 'crtc_state' description in 'intel_fbc_enable'
> drivers/gpu/drm/i915/display/intel_fbc.c:1124: warning: Excess function parameter 'plane_state' description in 'intel_fbc_enable'

Reviewed-by: Jani Nikula <jani.nikula at intel.com>

Arek, what does it take to enable automated documentation builds and
error reporting on CI?

>
> Signed-off-by: Chris Wilson <chris at chris-wilson.co.uk>
> ---
>  drivers/gpu/drm/i915/display/intel_atomic.c  | 2 ++
>  drivers/gpu/drm/i915/display/intel_display.c | 2 +-
>  drivers/gpu/drm/i915/display/intel_fbc.c     | 3 +--
>  3 files changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/gpu/drm/i915/display/intel_atomic.c b/drivers/gpu/drm/i915/display/intel_atomic.c
> index c362eecdd414..9921b1fa4e70 100644
> --- a/drivers/gpu/drm/i915/display/intel_atomic.c
> +++ b/drivers/gpu/drm/i915/display/intel_atomic.c
> @@ -178,6 +178,8 @@ intel_digital_connector_duplicate_state(struct drm_connector *connector)
>  
>  /**
>   * intel_connector_needs_modeset - check if connector needs a modeset
> + * @state: the atomic state corresponding to this modeset
> + * @connector: the connector
>   */
>  bool
>  intel_connector_needs_modeset(struct intel_atomic_state *state,
> diff --git a/drivers/gpu/drm/i915/display/intel_display.c b/drivers/gpu/drm/i915/display/intel_display.c
> index 9c81576dc43e..aaef06e19828 100644
> --- a/drivers/gpu/drm/i915/display/intel_display.c
> +++ b/drivers/gpu/drm/i915/display/intel_display.c
> @@ -15861,7 +15861,7 @@ static void fb_obj_bump_render_priority(struct drm_i915_gem_object *obj)
>  
>  /**
>   * intel_prepare_plane_fb - Prepare fb for usage on plane
> - * @plane: drm plane to prepare for
> + * @_plane: drm plane to prepare for
>   * @_new_plane_state: the plane state being prepared
>   *
>   * Prepares a framebuffer for usage on a display plane.  Generally this
> diff --git a/drivers/gpu/drm/i915/display/intel_fbc.c b/drivers/gpu/drm/i915/display/intel_fbc.c
> index 88a9c2fea695..d3be6f619b31 100644
> --- a/drivers/gpu/drm/i915/display/intel_fbc.c
> +++ b/drivers/gpu/drm/i915/display/intel_fbc.c
> @@ -1111,8 +1111,7 @@ void intel_fbc_choose_crtc(struct drm_i915_private *dev_priv,
>  /**
>   * intel_fbc_enable: tries to enable FBC on the CRTC
>   * @crtc: the CRTC
> - * @crtc_state: corresponding &drm_crtc_state for @crtc
> - * @plane_state: corresponding &drm_plane_state for the primary plane of @crtc
> + * @state: corresponding &drm_crtc_state for @crtc
>   *
>   * This function checks if the given CRTC was chosen for FBC, then enables it if
>   * possible. Notice that it doesn't activate FBC. It is valid to call

-- 
Jani Nikula, Intel Open Source Graphics Center