[PATCH] drm: fix drm_modeset_lock.h kernel-doc notation

[PATCH] drm: fix drm_modeset_lock.h kernel-doc notation

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix drm kernel-doc notation to squelch these warnings:

Warning(..//include/drm/drm_modeset_lock.h:41): cannot understand function prototype: 'struct drm_modeset_acquire_ctx '
Warning(..//include/drm/drm_modeset_lock.h:66): cannot understand function prototype: 'struct drm_modeset_lock '

Need to include the keyword 'struct' for structure descriptions.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 include/drm/drm_modeset_lock.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Index: lnx-317-rc1/include/drm/drm_modeset_lock.h
===================================================================
--- lnx-317-rc1.orig/include/drm/drm_modeset_lock.h
+++ lnx-317-rc1/include/drm/drm_modeset_lock.h
@@ -29,7 +29,7 @@
 struct drm_modeset_lock;
 
 /**
- * drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx)
+ * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx)
  * @ww_ctx: base acquire ctx
  * @contended: used internally for -EDEADLK handling
  * @locked: list of held locks
@@ -56,7 +56,7 @@ struct drm_modeset_acquire_ctx {
 };
 
 /**
- * drm_modeset_lock - used for locking modeset resources.
+ * struct drm_modeset_lock - used for locking modeset resources.
  * @mutex: resource locking
  * @head: used to hold it's place on state->locked list when
  *    part of an atomic update

Re: [PATCH] drm: fix drm_modeset_lock.h kernel-doc notation

[Daniel Vetter]

On Sat, Aug 16, 2014 at 02:15:34PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix drm kernel-doc notation to squelch these warnings:
> 
> Warning(..//include/drm/drm_modeset_lock.h:41): cannot understand function prototype: 'struct drm_modeset_acquire_ctx '
> Warning(..//include/drm/drm_modeset_lock.h:66): cannot understand function prototype: 'struct drm_modeset_lock '
> 
> Need to include the keyword 'struct' for structure descriptions.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

And pulled into my drm core stuff topic branch for 3.18 so it won't get
lost.
-Daniel

> ---
>  include/drm/drm_modeset_lock.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> Index: lnx-317-rc1/include/drm/drm_modeset_lock.h
> ===================================================================
> --- lnx-317-rc1.orig/include/drm/drm_modeset_lock.h
> +++ lnx-317-rc1/include/drm/drm_modeset_lock.h
> @@ -29,7 +29,7 @@
>  struct drm_modeset_lock;
>  
>  /**
> - * drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx)
> + * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx)
>   * @ww_ctx: base acquire ctx
>   * @contended: used internally for -EDEADLK handling
>   * @locked: list of held locks
> @@ -56,7 +56,7 @@ struct drm_modeset_acquire_ctx {
>  };
>  
>  /**
> - * drm_modeset_lock - used for locking modeset resources.
> + * struct drm_modeset_lock - used for locking modeset resources.
>   * @mutex: resource locking
>   * @head: used to hold it's place on state->locked list when
>   *    part of an atomic update
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel

-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch