[Intel-gfx] [PATCH v2 11/39] drm/i915: i915_gem_ttm_pm.c: fix kernel-doc markups

[Rodrigo Vivi]

On Wed, Jul 13, 2022 at 09:11:59AM +0100, Mauro Carvalho Chehab wrote:
> The documentation for the flags field is missing there. It sounds
> that some last-time change converted some bools into flags, but
> the kernel-doc change didn't follow it.
> 
> Fix those warnings:
> 
> 	drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c:135: warning: Function parameter or member 'flags' not described in 'i915_ttm_backup_region'
> 	drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c:135: warning: Excess function parameter 'allow_gpu' description in 'i915_ttm_backup_region'
> 	drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c:135: warning: Excess function parameter 'backup_pinned' description in 'i915_ttm_backup_region'
> 	drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c:199: warning: Function parameter or member 'flags' not described in 'i915_ttm_restore_region'
> 	drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c:199: warning: Excess function parameter 'allow_gpu' description in 'i915_ttm_restore_region'
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab at kernel.org>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>
> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/
> 
>  drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c b/drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c
> index 9aad84059d56..9843831c9b37 100644
> --- a/drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c
> +++ b/drivers/gpu/drm/i915/gem/i915_gem_ttm_pm.c
> @@ -123,8 +123,9 @@ void i915_ttm_recover_region(struct intel_memory_region *mr)
>  /**
>   * i915_ttm_backup_region - Back up all objects of a region to smem.
>   * @mr: The memory region
> - * @allow_gpu: Whether to allow the gpu blitter for this backup.
> - * @backup_pinned: Backup also pinned objects.
> + * @flags: Bitmap field with the following flags:
> + *	%I915_TTM_BACKUP_ALLOW_GPU: allow the gpu blitter for this backup;
> + *	%I915_TTM_BACKUP_PINNED: backup also pinned objects.
>   *
>   * Loops over all objects of a region and either evicts them if they are
>   * evictable or backs them up using a backup object if they are pinned.
> @@ -188,7 +189,8 @@ static int i915_ttm_restore(struct i915_gem_apply_to_region *apply,
>  /**
>   * i915_ttm_restore_region - Restore backed-up objects of a region from smem.
>   * @mr: The memory region
> - * @allow_gpu: Whether to allow the gpu blitter to recover.
> + * @flags: Bitmap field with the following flags:
> + *	%I915_TTM_BACKUP_ALLOW_GPU: allow the gpu blitter for this backup;
>   *
>   * Loops over all objects of a region and if they are backed-up, restores
>   * them from smem.
> -- 
> 2.36.1
>