linux-kernel - Re: [PATCH v2] drm/vram-helper: fix kernel-doc warnings

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] [thread-next>] [day] [month] [year] [list]

Date: Mon, 8 Jan 2024 09:57:31 +0100
From: Thomas Zimmermann <tzimmermann@...e.de>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: David Airlie <airlied@...il.com>, Daniel Vetter <daniel@...ll.ch>,
 dri-devel@...ts.freedesktop.org,
 Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
 Maxime Ripard <mripard@...nel.org>
Subject: Re: [PATCH v2] drm/vram-helper: fix kernel-doc warnings

Hi,

thanks for the fix.

Am 06.01.24 um 04:29 schrieb Randy Dunlap:
> Remove the @funcs entry from struct drm_vram_mm to quieten the kernel-doc
> warning.
> 
> Use the "define" kernel-doc keyword and an '\' line continuation
> to fix another kernel-doc warning.
> 
> drm_gem_vram_helper.h:129: warning: missing initial short description on line:
>   * DRM_GEM_VRAM_PLANE_HELPER_FUNCS -
> drm_gem_vram_helper.h:185: warning: Excess struct member 'funcs' description in 'drm_vram_mm'
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: David Airlie <airlied@...il.com>
> Cc: Daniel Vetter <daniel@...ll.ch>
> Cc: dri-devel@...ts.freedesktop.org
> Cc: Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>
> Cc: Maxime Ripard <mripard@...nel.org>
> Cc: Thomas Zimmermann <tzimmermann@...e.de>
> ---
> v2: Add commit description
> 
> base-commit: 610a9b8f49fbcf1100716370d3b5f6f884a2835a
> 
>   include/drm/drm_gem_vram_helper.h |    3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff -- a/include/drm/drm_gem_vram_helper.h b/include/drm/drm_gem_vram_helper.h
> --- a/include/drm/drm_gem_vram_helper.h
> +++ b/include/drm/drm_gem_vram_helper.h
> @@ -126,7 +126,7 @@ drm_gem_vram_plane_helper_cleanup_fb(str
>   				     struct drm_plane_state *old_state);
>   
>   /**
> - * DRM_GEM_VRAM_PLANE_HELPER_FUNCS -
> + * define DRM_GEM_VRAM_PLANE_HELPER_FUNCS - \

Did something change wrt. doc syntax? I think this used to work without 
warnings. About this 'define': we don't use is in another docs. Can we 
leave it out here or is this the new syntax?

Best regards
Thomas

>    *	Initializes struct drm_plane_helper_funcs for VRAM handling
>    *
>    * Drivers may use GEM BOs as VRAM helpers for the framebuffer memory. This
> @@ -170,7 +170,6 @@ void drm_gem_vram_simple_display_pipe_cl
>    * @vram_base:	Base address of the managed video memory
>    * @vram_size:	Size of the managed video memory in bytes
>    * @bdev:	The TTM BO device.
> - * @funcs:	TTM BO functions
>    *
>    * The fields &struct drm_vram_mm.vram_base and
>    * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are

-- 
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Frankenstrasse 146, 90461 Nuernberg, Germany
GF: Ivo Totev, Andrew Myers, Andrew McDonald, Boudien Moerman
HRB 36809 (AG Nuernberg)

Download attachment "OpenPGP_signature.asc" of type "application/pgp-signature" (841 bytes)