[Intel-gfx] [PATCH 03/24] drm/i915/utils: drop kernel-doc from __wait_for()

Rodrigo Vivi rodrigo.vivi at kernel.org
Wed May 3 14:09:58 UTC 2023


On Tue, May 02, 2023 at 06:37:20PM +0300, Jani Nikula wrote:
> The parameters aren't documented, and the file isn't included in Sphinx
> build anyway, so demote the kernel-doc to a regular comment.
> 
> drivers/gpu/drm/i915/i915_utils.h:284: warning: Function parameter or member 'OP' not described in '__wait_for'
> drivers/gpu/drm/i915/i915_utils.h:284: warning: Function parameter or member 'COND' not described in '__wait_for'
> drivers/gpu/drm/i915/i915_utils.h:284: warning: Function parameter or member 'US' not described in '__wait_for'
> drivers/gpu/drm/i915/i915_utils.h:284: warning: Function parameter or member 'Wmin' not described in '__wait_for'
> drivers/gpu/drm/i915/i915_utils.h:284: warning: Function parameter or member 'Wmax' not described in '__wait_for'
> 
> Signed-off-by: Jani Nikula <jani.nikula at intel.com>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>

> ---
>  drivers/gpu/drm/i915/i915_utils.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/i915/i915_utils.h b/drivers/gpu/drm/i915/i915_utils.h
> index 2c430c0c3bad..c61066498bf2 100644
> --- a/drivers/gpu/drm/i915/i915_utils.h
> +++ b/drivers/gpu/drm/i915/i915_utils.h
> @@ -250,7 +250,7 @@ wait_remaining_ms_from_jiffies(unsigned long timestamp_jiffies, int to_wait_ms)
>  	}
>  }
>  
> -/**
> +/*
>   * __wait_for - magic wait macro
>   *
>   * Macro to help avoid open coding check/wait/timeout patterns. Note that it's
> -- 
> 2.39.2
> 


More information about the Intel-gfx mailing list