Subject: [PATCH] drm/doc: Fixing xml documentation warning

"/**" should be used for kernel-doc documentation only.
It causes a warning with the new "in struct body" format.

Signed-off-by: Danilo Cesar Lemes de Paula <[email protected]>
Cc: Randy Dunlap <[email protected]>
Cc: Daniel Vetter <[email protected]>
Cc: Laurent Pinchart <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: Herbert Xu <[email protected]>
Cc: Stephan Mueller <[email protected]>
Cc: Michal Marek <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: intel-gfx <[email protected]>
Cc: dri-devel <[email protected]>
Cc: Graham Whaley <[email protected]>
---
include/drm/drm_modeset_lock.h | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h
index 70595ff..c16a3ec 100644
--- a/include/drm/drm_modeset_lock.h
+++ b/include/drm/drm_modeset_lock.h
@@ -43,19 +43,19 @@ struct drm_modeset_acquire_ctx {

struct ww_acquire_ctx ww_ctx;

- /**
+ /*
* Contended lock: if a lock is contended you should only call
* drm_modeset_backoff() which drops locks and slow-locks the
* contended lock.
*/
struct drm_modeset_lock *contended;

- /**
+ /*
* list of held locks (drm_modeset_lock)
*/
struct list_head locked;

- /**
+ /*
* Trylock mode, use only for panic handlers!
*/
bool trylock_only;
@@ -70,12 +70,12 @@ struct drm_modeset_acquire_ctx {
* Used for locking CRTCs and other modeset resources.
*/
struct drm_modeset_lock {
- /**
+ /*
* modeset lock
*/
struct ww_mutex mutex;

- /**
+ /*
* Resources that are locked as part of an atomic update are added
* to a list (so we know what to unlock at the end).
*/
--
2.4.3


2015-08-25 09:20:42

by Daniel Vetter

[permalink] [raw]
Subject: Re: [PATCH] drm/doc: Fixing xml documentation warning

On Fri, Aug 21, 2015 at 04:46:14PM -0300, Danilo Cesar Lemes de Paula wrote:
> "/**" should be used for kernel-doc documentation only.
> It causes a warning with the new "in struct body" format.
>
> Signed-off-by: Danilo Cesar Lemes de Paula <[email protected]>
> Cc: Randy Dunlap <[email protected]>
> Cc: Daniel Vetter <[email protected]>
> Cc: Laurent Pinchart <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: Herbert Xu <[email protected]>
> Cc: Stephan Mueller <[email protected]>
> Cc: Michal Marek <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: intel-gfx <[email protected]>
> Cc: dri-devel <[email protected]>
> Cc: Graham Whaley <[email protected]>

Applied to drm-misc, thanks.
-Daniel

> ---
> include/drm/drm_modeset_lock.h | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h
> index 70595ff..c16a3ec 100644
> --- a/include/drm/drm_modeset_lock.h
> +++ b/include/drm/drm_modeset_lock.h
> @@ -43,19 +43,19 @@ struct drm_modeset_acquire_ctx {
>
> struct ww_acquire_ctx ww_ctx;
>
> - /**
> + /*
> * Contended lock: if a lock is contended you should only call
> * drm_modeset_backoff() which drops locks and slow-locks the
> * contended lock.
> */
> struct drm_modeset_lock *contended;
>
> - /**
> + /*
> * list of held locks (drm_modeset_lock)
> */
> struct list_head locked;
>
> - /**
> + /*
> * Trylock mode, use only for panic handlers!
> */
> bool trylock_only;
> @@ -70,12 +70,12 @@ struct drm_modeset_acquire_ctx {
> * Used for locking CRTCs and other modeset resources.
> */
> struct drm_modeset_lock {
> - /**
> + /*
> * modeset lock
> */
> struct ww_mutex mutex;
>
> - /**
> + /*
> * Resources that are locked as part of an atomic update are added
> * to a list (so we know what to unlock at the end).
> */
> --
> 2.4.3
>

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

2015-08-25 13:25:53

by Daniel Vetter

[permalink] [raw]
Subject: Re: [PATCH] drm/doc: Fixing xml documentation warning

On Fri, Aug 21, 2015 at 04:46:14PM -0300, Danilo Cesar Lemes de Paula wrote:
> "/**" should be used for kernel-doc documentation only.
> It causes a warning with the new "in struct body" format.
>
> Signed-off-by: Danilo Cesar Lemes de Paula <[email protected]>
> Cc: Randy Dunlap <[email protected]>
> Cc: Daniel Vetter <[email protected]>
> Cc: Laurent Pinchart <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: Herbert Xu <[email protected]>
> Cc: Stephan Mueller <[email protected]>
> Cc: Michal Marek <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: intel-gfx <[email protected]>
> Cc: dri-devel <[email protected]>
> Cc: Graham Whaley <[email protected]>
> ---
> include/drm/drm_modeset_lock.h | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h
> index 70595ff..c16a3ec 100644
> --- a/include/drm/drm_modeset_lock.h
> +++ b/include/drm/drm_modeset_lock.h
> @@ -43,19 +43,19 @@ struct drm_modeset_acquire_ctx {
>
> struct ww_acquire_ctx ww_ctx;
>
> - /**
> + /*
> * Contended lock: if a lock is contended you should only call
> * drm_modeset_backoff() which drops locks and slow-locks the
> * contended lock.
> */
> struct drm_modeset_lock *contended;

On second thought this is perfect use-case for the new per-member
kerneldoc support we've recently added.
>
> - /**
> + /*
> * list of held locks (drm_modeset_lock)
> */
> struct list_head locked;
>
> - /**
> + /*
> * Trylock mode, use only for panic handlers!
> */
> bool trylock_only;
> @@ -70,12 +70,12 @@ struct drm_modeset_acquire_ctx {
> * Used for locking CRTCs and other modeset resources.
> */
> struct drm_modeset_lock {
> - /**
> + /*
> * modeset lock
> */

Same here.
-Daniel

> struct ww_mutex mutex;
>
> - /**
> + /*
> * Resources that are locked as part of an atomic update are added
> * to a list (so we know what to unlock at the end).
> */
> --
> 2.4.3
>

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch