[Intel-gfx] [PATCH 22/24] drm/i915/scatterlist: fix kernel-doc

Rodrigo Vivi rodrigo.vivi at kernel.org
Thu May 4 14:56:06 UTC 2023


On Tue, May 02, 2023 at 06:37:39PM +0300, Jani Nikula wrote:
> Can't document function pointer members as if they are functions.
> 
> drivers/gpu/drm/i915/i915_scatterlist.h:160: warning: Incorrect use of kernel-doc format:          * release() - Free the memory of the struct i915_refct_sgt
> 
> Signed-off-by: Jani Nikula <jani.nikula at intel.com>

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

> ---
>  drivers/gpu/drm/i915/i915_scatterlist.h | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/i915_scatterlist.h b/drivers/gpu/drm/i915/i915_scatterlist.h
> index b0a1db44f895..fe9ae863f9b9 100644
> --- a/drivers/gpu/drm/i915/i915_scatterlist.h
> +++ b/drivers/gpu/drm/i915/i915_scatterlist.h
> @@ -157,8 +157,7 @@ bool i915_sg_trim(struct sg_table *orig_st);
>   */
>  struct i915_refct_sgt_ops {
>  	/**
> -	 * release() - Free the memory of the struct i915_refct_sgt
> -	 * @ref: struct kref that is embedded in the struct i915_refct_sgt
> +	 * @release: Free the memory of the struct i915_refct_sgt
>  	 */
>  	void (*release)(struct kref *ref);
>  };
> -- 
> 2.39.2
> 


More information about the Intel-gfx mailing list