Skip to contentSkip to conversation

drm: fix drm_modeset_lock.h kernel-doc notation

PATCH In review Randy Dunlap 2 participants 2 messages Aug 16, 2014 – Aug 25, 2014

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm: fix drm_modeset_lock.h kernel-doc notation

From: Randy Dunlap <[email protected]>

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.

---
 include/drm/drm_modeset_lock.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
include/drm/drm_modeset_lock.h +2 -2
Index: 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
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

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.

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

Quoted 30 lines
---
 include/drm/drm_modeset_lock.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Index: lnx-317-rc1/include/drm/drm_modeset_lock.h
===================================================================

include/drm/drm_modeset_lock.h +2 -2
@@ -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
[email protected]
http://lists.freedesktop.org/mailman/listinfo/dri-devel

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