Re: [PATCH] drm/vmwgfx: fix kernel-doc Excess struct member 'base'

[Zack Rusin]

On Fri, Dec 15, 2023 at 6:56 PM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>
> Fix a new kernel-doc warning reported by kernel test robot:
>
> vmwgfx_surface.c:55: warning: Excess struct member 'base' description in 'vmw_user_surface'
>
> The other warning is not correct: it is confused by "__counted_by".
> Kees has made a separate patch for that.
>
> In -Wall mode, kernel-doc still reports 20 warnings of this nature:
> vmwgfx_surface.c:198: warning: No description found for return value of 'vmw_surface_dma_size'
> but I am not addressing those.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Closes: https://lore.kernel.org/oe-kbuild-all/202312150701.kNI9LuM3-lkp@xxxxxxxxx/
> Cc: Kees Cook <keescook@xxxxxxxxxxxx>
> Cc: Zack Rusin <zackr@xxxxxxxxxx>
> Cc: VMware Graphics Reviewers <linux-graphics-maintainer@xxxxxxxxxx>
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> Cc: Maarten Lankhorst <maarten.lankhorst@xxxxxxxxxxxxxxx>
> Cc: Maxime Ripard <mripard@xxxxxxxxxx>
> Cc: Thomas Zimmermann <tzimmermann@xxxxxxx>
> ---
>  drivers/gpu/drm/vmwgfx/vmwgfx_surface.c |    1 -
>  1 file changed, 1 deletion(-)
>
> diff -- a/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c b/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c
> --- a/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c
> +++ b/drivers/gpu/drm/vmwgfx/vmwgfx_surface.c
> @@ -44,7 +44,6 @@
>   * struct vmw_user_surface - User-space visible surface resource
>   *
>   * @prime:          The TTM prime object.
> - * @base:           The TTM base object handling user-space visibility.
>   * @srf:            The surface metadata.
>   * @master:         Master of the creating client. Used for security check.
>   */

Thanks, looks great. I went ahead and pushed this one to drm-misc-next.

z