linux-kernel - Re: [PATCH linux-next] drm: Fix for kernel doc warning

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: <87frp58e0h.fsf@intel.com>
Date: Wed, 09 Oct 2024 18:58:06 +0300
From: Jani Nikula <jani.nikula@...ux.intel.com>
To: R Sundar <prosunofficial@...il.com>, Maarten Lankhorst
 <maarten.lankhorst@...ux.intel.com>, Maxime Ripard <mripard@...nel.org>,
 Thomas Zimmermann <tzimmermann@...e.de>, David Airlie <airlied@...il.com>,
 Simona Vetter <simona@...ll.ch>
Cc: dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org, R Sundar
 <prosunofficial@...il.com>
Subject: Re: [PATCH linux-next] drm: Fix for kernel doc warning

On Thu, 03 Oct 2024, R Sundar <prosunofficial@...il.com> wrote:
> Added colon in kernel-doc comment to fix the warning.
>
> ./include/drm/drm_drv.h:372: warning: Incorrect use of kernel-doc format:          * @fbdev_probe
> ./include/drm/drm_drv.h:435: warning: Function parameter or struct member 'fbdev_probe' not described in 'drm_driver'
>
> Signed-off-by: R Sundar <prosunofficial@...il.com>

Pushed to drm-misc-next, thanks for the patch.

BR,
Jani.

> ---
>  include/drm/drm_drv.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/drm/drm_drv.h b/include/drm/drm_drv.h
> index 36a606af4ba1..1bbbcb8e2d23 100644
> --- a/include/drm/drm_drv.h
> +++ b/include/drm/drm_drv.h
> @@ -369,7 +369,7 @@ struct drm_driver {
>  			       uint64_t *offset);
>  
>  	/**
> -	 * @fbdev_probe
> +	 * @fbdev_probe:
>  	 *
>  	 * Allocates and initialize the fb_info structure for fbdev emulation.
>  	 * Furthermore it also needs to allocate the DRM framebuffer used to

-- 
Jani Nikula, Intel