diff mbox series

[-next] drm/client: fix kernel-doc warning in drm_client.h

Message ID 20230131012107.20943-1-rdunlap@infradead.org
State New
Headers
Series [-next] drm/client: fix kernel-doc warning in drm_client.h |

Commit Message

Randy Dunlap Jan. 31, 2023, 1:21 a.m. UTC 
  scripts/kernel-doc complains about the comment for hotplug_failed,
so fix it:

include/drm/drm_client.h:111: warning: Incorrect use of kernel-doc format:          * @hotplug failed:

Fixes: 6a9d5ad3af65 ("drm/client: Add hotplug_failed flag")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Javier Martinez Canillas <javierm@redhat.com>
Cc: David Airlie <airlied@gmail.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
---
 include/drm/drm_client.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Thomas Zimmermann Feb. 1, 2023, 3:34 p.m. UTC | #1 
Am 31.01.23 um 02:21 schrieb Randy Dunlap:
> scripts/kernel-doc complains about the comment for hotplug_failed,
> so fix it:
> 
> include/drm/drm_client.h:111: warning: Incorrect use of kernel-doc format:          * @hotplug failed:
> 
> Fixes: 6a9d5ad3af65 ("drm/client: Add hotplug_failed flag")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <mripard@kernel.org>
> Cc: Javier Martinez Canillas <javierm@redhat.com>
> Cc: David Airlie <airlied@gmail.com>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: dri-devel@lists.freedesktop.org

Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>

I've added your patch to drm-misc-next-fixes.

> ---
>   include/drm/drm_client.h |    2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/include/drm/drm_client.h b/include/drm/drm_client.h
> --- a/include/drm/drm_client.h
> +++ b/include/drm/drm_client.h
> @@ -108,7 +108,7 @@ struct drm_client_dev {
>   	struct drm_mode_set *modesets;
>   
>   	/**
> -	 * @hotplug failed:
> +	 * @hotplug_failed:
>   	 *
>   	 * Set by client hotplug helpers if the hotplugging failed
>   	 * before. It is usually not tried again.

-- 
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
(HRB 36809, AG Nürnberg)
Geschäftsführer: Ivo Totev
diff mbox series

Patch

diff -- a/include/drm/drm_client.h b/include/drm/drm_client.h
--- a/include/drm/drm_client.h
+++ b/include/drm/drm_client.h
@@ -108,7 +108,7 @@  struct drm_client_dev {
 	struct drm_mode_set *modesets;
 
 	/**
-	 * @hotplug failed:
+	 * @hotplug_failed:
 	 *
 	 * Set by client hotplug helpers if the hotplugging failed
 	 * before. It is usually not tried again.