[PATCH] drm/doc: Fixing xml documentation warning

[PATCH] drm/doc: Fixing xml documentation warning

[Danilo Cesar Lemes de Paula]

"/**" 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 <danilo.cesar@collabora.co.uk>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Stephan Mueller <smueller@chronox.de>
Cc: Michal Marek <mmarek@suse.cz>
Cc: linux-kernel@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Cc: intel-gfx <intel-gfx@lists.freedesktop.org>
Cc: dri-devel <dri-devel@lists.freedesktop.org>
Cc: Graham Whaley <graham.whaley@linux.intel.com>
---
 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

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

[Daniel Vetter]

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 <danilo.cesar@collabora.co.uk>
> Cc: Randy Dunlap <rdunlap@infradead.org>
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: Stephan Mueller <smueller@chronox.de>
> Cc: Michal Marek <mmarek@suse.cz>
> Cc: linux-kernel@vger.kernel.org
> Cc: linux-doc@vger.kernel.org
> Cc: intel-gfx <intel-gfx@lists.freedesktop.org>
> Cc: dri-devel <dri-devel@lists.freedesktop.org>
> Cc: Graham Whaley <graham.whaley@linux.intel.com>

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

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

[Daniel Vetter]

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 <danilo.cesar@collabora.co.uk>
> Cc: Randy Dunlap <rdunlap@infradead.org>
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: Stephan Mueller <smueller@chronox.de>
> Cc: Michal Marek <mmarek@suse.cz>
> Cc: linux-kernel@vger.kernel.org
> Cc: linux-doc@vger.kernel.org
> Cc: intel-gfx <intel-gfx@lists.freedesktop.org>
> Cc: dri-devel <dri-devel@lists.freedesktop.org>
> Cc: Graham Whaley <graham.whaley@linux.intel.com>
> ---
>  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