[PATCH v3 3/5] drm/doc: re-format drm.h file comment

Simon Ser contact at emersion.fr
Tue Dec 22 13:31:43 UTC 2020


Our documentation build system chokes on \file comments:

    ./include/uapi/drm/drm.h:2: warning: Cannot understand  * \file drm.h
     on line 2 - I thought it was a doc line

Remove all of the slash-directives, and demote to a normal comment. Keep
the historical information because it predates Git.

v3: keep the comment (Daniel)

Signed-off-by: Simon Ser <contact at emersion.fr>
Acked-by: Daniel Vetter <daniel at ffwll.ch>
Cc: Pekka Paalanen <ppaalanen at gmail.com>
---
 include/uapi/drm/drm.h | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/include/uapi/drm/drm.h b/include/uapi/drm/drm.h
index 5c31aea1f342..a3ee8e01c295 100644
--- a/include/uapi/drm/drm.h
+++ b/include/uapi/drm/drm.h
@@ -1,11 +1,10 @@
-/**
- * \file drm.h
+/*
  * Header for the Direct Rendering Manager
  *
- * \author Rickard E. (Rik) Faith <faith at valinux.com>
+ * Author: Rickard E. (Rik) Faith <faith at valinux.com>
  *
- * \par Acknowledgments:
- * Dec 1999, Richard Henderson <rth at twiddle.net>, move to generic \c cmpxchg.
+ * Acknowledgments:
+ * Dec 1999, Richard Henderson <rth at twiddle.net>, move to generic cmpxchg.
  */
 
 /*
-- 
2.29.2



More information about the dri-devel mailing list