[PATCH 1/4] drm/nouveau/disp: don't misuse kernel-doc comments

Danilo Krummrich dakr at redhat.com
Mon Jan 8 17:41:48 UTC 2024


On 1/1/24 00:36, Randy Dunlap wrote:
> Change kernel-doc "/**" comments to common "/*" comments to prevent
> kernel-doc warnings:
> 
> crtc.c:453: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Sets up registers for the given mode/adjusted_mode pair.
> crtc.c:453: warning: missing initial short description on line:
>   * Sets up registers for the given mode/adjusted_mode pair.
> crtc.c:629: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Sets up registers for the given mode/adjusted_mode pair.
> crtc.c:629: warning: missing initial short description on line:
>   * Sets up registers for the given mode/adjusted_mode pair.
> 
> Signed-off-by: Randy Dunlap <rdunlap at infradead.org>
> Cc: Karol Herbst <kherbst at redhat.com>
> Cc: Lyude Paul <lyude at redhat.com>
> Cc: Danilo Krummrich <dakr at redhat.com>
> Cc: nouveau at lists.freedesktop.org
> Cc: Maarten Lankhorst <maarten.lankhorst at linux.intel.com>
> Cc: Maxime Ripard <mripard at kernel.org>
> Cc: Thomas Zimmermann <tzimmermann at suse.de>

Series applied to drm-misc-next, thanks!

> ---
>   drivers/gpu/drm/nouveau/dispnv04/crtc.c |    4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff -- a/drivers/gpu/drm/nouveau/dispnv04/crtc.c b/drivers/gpu/drm/nouveau/dispnv04/crtc.c
> --- a/drivers/gpu/drm/nouveau/dispnv04/crtc.c
> +++ b/drivers/gpu/drm/nouveau/dispnv04/crtc.c
> @@ -449,7 +449,7 @@ nv_crtc_mode_set_vga(struct drm_crtc *cr
>   	regp->Attribute[NV_CIO_AR_CSEL_INDEX] = 0x00;
>   }
>   
> -/**
> +/*
>    * Sets up registers for the given mode/adjusted_mode pair.
>    *
>    * The clocks, CRTCs and outputs attached to this CRTC must be off.
> @@ -625,7 +625,7 @@ nv_crtc_swap_fbs(struct drm_crtc *crtc,
>   	return ret;
>   }
>   
> -/**
> +/*
>    * Sets up registers for the given mode/adjusted_mode pair.
>    *
>    * The clocks, CRTCs and outputs attached to this CRTC must be off.
> 



More information about the dri-devel mailing list