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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Tue, 25 Aug 2015 11:20:31 +0200
From:	Daniel Vetter <daniel@...ll.ch>
To:	Danilo Cesar Lemes de Paula <danilo.cesar@...labora.co.uk>
Cc:	Randy Dunlap <rdunlap@...radead.org>,
	Daniel Vetter <daniel.vetter@...ll.ch>,
	Laurent Pinchart <laurent.pinchart@...asonboard.com>,
	Jonathan Corbet <corbet@....net>,
	Herbert Xu <herbert@...dor.apana.org.au>,
	Stephan Mueller <smueller@...onox.de>,
	Michal Marek <mmarek@...e.cz>, linux-kernel@...r.kernel.org,
	linux-doc@...r.kernel.org,
	intel-gfx <intel-gfx@...ts.freedesktop.org>,
	dri-devel <dri-devel@...ts.freedesktop.org>,
	Graham Whaley <graham.whaley@...ux.intel.com>
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 <danilo.cesar@...labora.co.uk>
> Cc: Randy Dunlap <rdunlap@...radead.org>
> Cc: Daniel Vetter <daniel.vetter@...ll.ch>
> Cc: Laurent Pinchart <laurent.pinchart@...asonboard.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Herbert Xu <herbert@...dor.apana.org.au>
> Cc: Stephan Mueller <smueller@...onox.de>
> Cc: Michal Marek <mmarek@...e.cz>
> Cc: linux-kernel@...r.kernel.org
> Cc: linux-doc@...r.kernel.org
> Cc: intel-gfx <intel-gfx@...ts.freedesktop.org>
> Cc: dri-devel <dri-devel@...ts.freedesktop.org>
> Cc: Graham Whaley <graham.whaley@...ux.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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/