2021-10-03 05:27:31

by Randy Dunlap

Subject: [PATCH] drm/i915/gvt: clean up kernel-doc in gtt.c

Fix kernel-doc warnings in gtt.c:

gtt.c:1152: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Check if can do 2M page
gtt.c:1152: warning: missing initial short description on line:
* Check if can do 2M page
gtt.c:2209: warning: expecting prototype for intel_vgpu_emulate_gtt_mmio_read(). Prototype was for intel_vgpu_emulate_ggtt_mmio_read() instead

Fixes: a752b070a678 ("drm/i915/gvt: Fix function comment doc errors")
Fixes: 2707e4446688 ("drm/i915/gvt: vGPU graphics memory virtualization")
Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: kernel test robot <[email protected]>
Cc: Zhenyu Wang <[email protected]>
Cc: Zhi Wang <[email protected]>
Cc: Colin Xu <[email protected]>
Cc: Jani Nikula <[email protected]>
Cc: Joonas Lahtinen <[email protected]>
Cc: Rodrigo Vivi <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: David Airlie <[email protected]>
Cc: Daniel Vetter <[email protected]>
---
drivers/gpu/drm/i915/gvt/gtt.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20211001.orig/drivers/gpu/drm/i915/gvt/gtt.c
+++ linux-next-20211001/drivers/gpu/drm/i915/gvt/gtt.c
@@ -1148,7 +1148,7 @@ static inline void ppgtt_generate_shadow
ops->set_pfn(se, s->shadow_page.mfn);
}

-/**
+/*
* Check if can do 2M page
* @vgpu: target vgpu
* @entry: target pfn's gtt entry
@@ -2193,7 +2193,7 @@ static int emulate_ggtt_mmio_read(struct
}

/**
- * intel_vgpu_emulate_gtt_mmio_read - emulate GTT MMIO register read
+ * intel_vgpu_emulate_ggtt_mmio_read - emulate GTT MMIO register read
* @vgpu: a vGPU
* @off: register offset
* @p_data: data will be returned to guest

2021-10-12 10:09:49

by Wang, Zhi A

Subject: Re: [PATCH] drm/i915/gvt: clean up kernel-doc in gtt.c

On 10/3/21 5:23 AM, Randy Dunlap wrote:
> Fix kernel-doc warnings in gtt.c:
>
> gtt.c:1152: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * Check if can do 2M page
> gtt.c:1152: warning: missing initial short description on line:
> * Check if can do 2M page
> gtt.c:2209: warning: expecting prototype for intel_vgpu_emulate_gtt_mmio_read(). Prototype was for intel_vgpu_emulate_ggtt_mmio_read() instead
>
> Fixes: a752b070a678 ("drm/i915/gvt: Fix function comment doc errors")
> Fixes: 2707e4446688 ("drm/i915/gvt: vGPU graphics memory virtualization")
> Signed-off-by: Randy Dunlap <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Cc: Zhenyu Wang <[email protected]>
> Cc: Zhi Wang <[email protected]>
> Cc: Colin Xu <[email protected]>
> Cc: Jani Nikula <[email protected]>
> Cc: Joonas Lahtinen <[email protected]>
> Cc: Rodrigo Vivi <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
> Cc: David Airlie <[email protected]>
> Cc: Daniel Vetter <[email protected]>
> ---
> drivers/gpu/drm/i915/gvt/gtt.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20211001.orig/drivers/gpu/drm/i915/gvt/gtt.c
> +++ linux-next-20211001/drivers/gpu/drm/i915/gvt/gtt.c
> @@ -1148,7 +1148,7 @@ static inline void ppgtt_generate_shadow
> ops->set_pfn(se, s->shadow_page.mfn);
> }
>
> -/**
> +/*
> * Check if can do 2M page
> * @vgpu: target vgpu
> * @entry: target pfn's gtt entry
> @@ -2193,7 +2193,7 @@ static int emulate_ggtt_mmio_read(struct
> }
>
> /**
> - * intel_vgpu_emulate_gtt_mmio_read - emulate GTT MMIO register read
> + * intel_vgpu_emulate_ggtt_mmio_read - emulate GTT MMIO register read
> * @vgpu: a vGPU
> * @off: register offset
> * @p_data: data will be returned to guest
>
Thanks for the patch. queued.
Reviewed-by: Zhi Wang <[email protected]>