From: Daniel Vetter <daniel@ffwll.ch>
To: Simon Ser <contact@emersion.fr>
Cc: dri-devel@lists.freedesktop.org
Subject: Re: [PATCH v2 7/9] drm/doc: remove drm.h file comment
Date: Thu, 17 Dec 2020 13:07:34 +0100 [thread overview]
Message-ID: <X9tKBhRxID7kjsCP@phenom.ffwll.local> (raw)
In-Reply-To: <20201217113220.102271-8-contact@emersion.fr>
On Thu, Dec 17, 2020 at 12:32:18PM +0100, Simon Ser wrote:
> Our documentation build system chokes on \file comments. This comment
> seems mostly historical and doesn't provide any useful information.
>
> ./include/uapi/drm/drm.h:2: warning: Cannot understand * \file drm.h
> on line 2 - I thought it was a doc line
>
> Signed-off-by: Simon Ser <contact@emersion.fr>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Pekka Paalanen <ppaalanen@gmail.com>
I think just removing the formatting and leaving the historical author
info here (this long predates git) is better. For that version:
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
> ---
> include/uapi/drm/drm.h | 10 ----------
> 1 file changed, 10 deletions(-)
>
> diff --git a/include/uapi/drm/drm.h b/include/uapi/drm/drm.h
> index 5c31aea1f342..783f666152a1 100644
> --- a/include/uapi/drm/drm.h
> +++ b/include/uapi/drm/drm.h
> @@ -1,13 +1,3 @@
> -/**
> - * \file drm.h
> - * Header for the Direct Rendering Manager
> - *
> - * \author Rickard E. (Rik) Faith <faith@valinux.com>
> - *
> - * \par Acknowledgments:
> - * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic \c cmpxchg.
> - */
> -
> /*
> * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
> * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
> --
> 2.29.2
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2020-12-17 12:07 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-17 11:32 [PATCH v2 0/9] drm/doc: misc documentation improvements Simon Ser
2020-12-17 11:32 ` [PATCH v2 1/9] drm/doc: the KMS properties section is for user-space devs Simon Ser
2020-12-17 12:03 ` Daniel Vetter
2020-12-17 11:32 ` [PATCH v2 2/9] drm/doc: introduce new section for standard plane properties Simon Ser
2020-12-17 11:32 ` [PATCH v2 3/9] drm/doc: fix reference to drm_format_modifier_blob Simon Ser
2020-12-17 12:04 ` Daniel Vetter
2020-12-17 11:32 ` [PATCH v2 4/9] drm/doc: fix drm_plane_type docs Simon Ser
2020-12-17 12:05 ` Daniel Vetter
2020-12-17 11:32 ` [PATCH v2 5/9] drm/doc: document the type plane property Simon Ser
2020-12-17 12:13 ` Daniel Vetter
2020-12-17 11:32 ` [PATCH v2 6/9] drm/doc: atomic implicitly enables other caps Simon Ser
2020-12-17 12:05 ` Daniel Vetter
2020-12-17 11:32 ` [PATCH v2 7/9] drm/doc: remove drm.h file comment Simon Ser
2020-12-17 12:07 ` Daniel Vetter [this message]
2020-12-17 11:32 ` [PATCH v2 8/9] drm/doc: demote old doc-comments in drm.h Simon Ser
2020-12-17 12:13 ` Daniel Vetter
2020-12-17 11:32 ` [PATCH v2 9/9] drm/doc: render drm.h uapi docs Simon Ser
2020-12-17 12:14 ` Daniel Vetter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=X9tKBhRxID7kjsCP@phenom.ffwll.local \
--to=daniel@ffwll.ch \
--cc=contact@emersion.fr \
--cc=dri-devel@lists.freedesktop.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox