[PATCH] drm/i915: fix kernel-doc warnings in i915_gem_gtt.c

[PATCH] drm/i915: fix kernel-doc warnings in i915_gem_gtt.c

[Geliang Tang]

Fix the following 'make htmldocs' warnings:

  .//drivers/gpu/drm/i915/i915_gem_gtt.c:758: warning: No description found for parameter 'length'
  .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'length'
  .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'new_pds'
  .//drivers/gpu/drm/i915/i915_gem_gtt.c:758: warning: No description found for parameter 'length'
  .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'length'
  .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'new_pds'

Signed-off-by: Geliang Tang <geliangtang@163.com>
---
 drivers/gpu/drm/i915/i915_gem_gtt.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/gpu/drm/i915/i915_gem_gtt.c b/drivers/gpu/drm/i915/i915_gem_gtt.c
index 96054a5..c070a1f 100644
--- a/drivers/gpu/drm/i915/i915_gem_gtt.c
+++ b/drivers/gpu/drm/i915/i915_gem_gtt.c
@@ -737,7 +737,7 @@ static void gen8_ppgtt_cleanup(struct i915_address_space *vm)
  * @ppgtt:	Master ppgtt structure.
  * @pd:		Page directory for this address range.
  * @start:	Starting virtual address to begin allocations.
- * @length	Size of the allocations.
+ * @length:	Size of the allocations.
  * @new_pts:	Bitmap set by function with new allocations. Likely used by the
  *		caller to free on error.
  *
@@ -792,8 +792,8 @@ unwind_out:
  * @ppgtt:	Master ppgtt structure.
  * @pdp:	Page directory pointer for this address range.
  * @start:	Starting virtual address to begin allocations.
- * @length	Size of the allocations.
- * @new_pds	Bitmap set by function with new allocations. Likely used by the
+ * @length:	Size of the allocations.
+ * @new_pds:	Bitmap set by function with new allocations. Likely used by the
  *		caller to free on error.
  *
  * Allocate the required number of page directories starting at the pde index of
-- 
1.9.1

Re: [PATCH] drm/i915: fix kernel-doc warnings in i915_gem_gtt.c

[Jani Nikula]

On Tue, 15 Sep 2015, Geliang Tang <geliangtang@163.com> wrote:
> Fix the following 'make htmldocs' warnings:
>
>   .//drivers/gpu/drm/i915/i915_gem_gtt.c:758: warning: No description found for parameter 'length'
>   .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'length'
>   .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'new_pds'
>   .//drivers/gpu/drm/i915/i915_gem_gtt.c:758: warning: No description found for parameter 'length'
>   .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'length'
>   .//drivers/gpu/drm/i915/i915_gem_gtt.c:818: warning: No description found for parameter 'new_pds'

These are already fixed by

commit d4ec9da0e17cb6a86c0b76c5b254981601d25031
Author: Michel Thierry <michel.thierry@intel.com>
Date:   Thu Jul 30 11:02:03 2015 +0100

    drm/i915/gen8: Abstract PDP usage

Thanks,
Jani.


>
> Signed-off-by: Geliang Tang <geliangtang@163.com>
> ---
>  drivers/gpu/drm/i915/i915_gem_gtt.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/gpu/drm/i915/i915_gem_gtt.c b/drivers/gpu/drm/i915/i915_gem_gtt.c
> index 96054a5..c070a1f 100644
> --- a/drivers/gpu/drm/i915/i915_gem_gtt.c
> +++ b/drivers/gpu/drm/i915/i915_gem_gtt.c
> @@ -737,7 +737,7 @@ static void gen8_ppgtt_cleanup(struct i915_address_space *vm)
>   * @ppgtt:	Master ppgtt structure.
>   * @pd:		Page directory for this address range.
>   * @start:	Starting virtual address to begin allocations.
> - * @length	Size of the allocations.
> + * @length:	Size of the allocations.
>   * @new_pts:	Bitmap set by function with new allocations. Likely used by the
>   *		caller to free on error.
>   *
> @@ -792,8 +792,8 @@ unwind_out:
>   * @ppgtt:	Master ppgtt structure.
>   * @pdp:	Page directory pointer for this address range.
>   * @start:	Starting virtual address to begin allocations.
> - * @length	Size of the allocations.
> - * @new_pds	Bitmap set by function with new allocations. Likely used by the
> + * @length:	Size of the allocations.
> + * @new_pds:	Bitmap set by function with new allocations. Likely used by the
>   *		caller to free on error.
>   *
>   * Allocate the required number of page directories starting at the pde index of
> -- 
> 1.9.1
>
>

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/intel-gfx