| Message ID | 20201217113220.102271-8-contact@emersion.fr (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/doc: misc documentation improvements | expand |
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 >
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.
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> --- include/uapi/drm/drm.h | 10 ---------- 1 file changed, 10 deletions(-)