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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <39041738-e208-f1ad-8886-a8c8685bd9ec@intel.com>
Date:   Tue, 12 Oct 2021 10:07:43 +0000
From:   "Wang, Zhi A" <zhi.a.wang@...el.com>
To:     Randy Dunlap <rdunlap@...radead.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
CC:     lkp <lkp@...el.com>, Zhenyu Wang <zhenyuw@...ux.intel.com>,
        "Xu, Colin" <colin.xu@...el.com>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        "Joonas Lahtinen" <joonas.lahtinen@...ux.intel.com>,
        "Vivi, Rodrigo" <rodrigo.vivi@...el.com>,
        "intel-gfx@...ts.freedesktop.org" <intel-gfx@...ts.freedesktop.org>,
        "intel-gvt-dev@...ts.freedesktop.org" 
        <intel-gvt-dev@...ts.freedesktop.org>,
        "dri-devel@...ts.freedesktop.org" <dri-devel@...ts.freedesktop.org>,
        David Airlie <airlied@...ux.ie>,
        "Daniel Vetter" <daniel@...ll.ch>
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 <rdunlap@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Zhenyu Wang <zhenyuw@...ux.intel.com>
> Cc: Zhi Wang <zhi.a.wang@...el.com>
> Cc: Colin Xu <colin.xu@...el.com>
> Cc: Jani Nikula <jani.nikula@...ux.intel.com>
> Cc: Joonas Lahtinen <joonas.lahtinen@...ux.intel.com>
> Cc: Rodrigo Vivi <rodrigo.vivi@...el.com>
> Cc: intel-gfx@...ts.freedesktop.org
> Cc: intel-gvt-dev@...ts.freedesktop.org
> Cc: dri-devel@...ts.freedesktop.org
> Cc: David Airlie <airlied@...ux.ie>
> Cc: Daniel Vetter <daniel@...ll.ch>
> ---
>   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 <zhi.a.wang@...el.com>