[PATCH libinput] Rename README to README.md, include properly from doxygen

Peter Hutterer peter.hutterer at who-t.net
Thu Apr 20 05:59:06 UTC 2017


As of doxygen 1.8.3 (Dec 2012) doxygen can include a README.md directly as
mainpage. This avoids the ugly doxygen bits we have in the current README.

Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
Mostly sending this out so people learn about the USE_MDFILE_AS_MAINPAGE
doxygen command which I didn't know about until today - despite it being
around for over 4 years :)

 README.txt => README.md | 4 ----
 configure.ac            | 4 ++--
 doc/Makefile.am         | 2 +-
 doc/libinput.doxygen.in | 3 ++-
 4 files changed, 5 insertions(+), 8 deletions(-)
 rename README.txt => README.md (99%)

diff --git a/README.txt b/README.md
similarity index 99%
rename from README.txt
rename to README.md
index 1a7ffc5..ce1b673 100644
--- a/README.txt
+++ b/README.md
@@ -1,5 +1,3 @@
-/*!@mainpage
-
 libinput
 ========
 
@@ -94,5 +92,3 @@ libinput is licensed under the MIT license.
 
 See the [COPYING](http://cgit.freedesktop.org/wayland/libinput/tree/COPYING)
 file for the full license information.
-
-*/
diff --git a/configure.ac b/configure.ac
index 61a964c..82a2f22 100644
--- a/configure.ac
+++ b/configure.ac
@@ -117,13 +117,13 @@ if test "x$build_documentation" = "xyes"; then
 
 	AC_MSG_CHECKING([for compatible doxygen version])
 	doxygen_version=`$DOXYGEN --version`
-	AS_VERSION_COMPARE([$doxygen_version], [1.6.0],
+	AS_VERSION_COMPARE([$doxygen_version], [1.8.3],
 			   [AC_MSG_RESULT([no])
 			    DOXYGEN=""],
 			   [AC_MSG_RESULT([yes])],
 			   [AC_MSG_RESULT([yes])])
 	if test "x$DOXYGEN" = "x"; then
-		AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.6+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation])
+		AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.8.3+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation])
 	fi
 
 	AC_PATH_PROG(DOT, dot)
diff --git a/doc/Makefile.am b/doc/Makefile.am
index af06272..5391f22 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,7 +5,7 @@ EXTRA_DIST = \
 
 header_files = \
 	$(top_srcdir)/src/libinput.h \
-	$(top_srcdir)/README.txt \
+	$(top_srcdir)/README.md \
 	$(srcdir)/absolute-axes.dox \
 	$(srcdir)/absolute-coordinate-ranges.dox \
 	$(srcdir)/building.dox \
diff --git a/doc/libinput.doxygen.in b/doc/libinput.doxygen.in
index 300d2f7..3dd4101 100644
--- a/doc/libinput.doxygen.in
+++ b/doc/libinput.doxygen.in
@@ -9,7 +9,7 @@ EXTRACT_STATIC         = YES
 MAX_INITIALIZER_LINES  = 0
 QUIET                  = YES
 INPUT                  = @top_srcdir@/src/libinput.h \
-			 @top_srcdir@/README.txt
+			 @top_srcdir@/README.md
 IMAGE_PATH             = @top_srcdir@/doc/svg \
 			 @top_srcdir@/doc/dot
 GENERATE_HTML          = YES
@@ -28,3 +28,4 @@ HTML_FOOTER = @top_srcdir@/doc/style/footer.html
 HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/style/bootstrap.css \
 			@top_srcdir@/doc/style/customdoxygen.css \
 			@top_srcdir@/doc/style/libinputdoxygen.css
+USE_MDFILE_AS_MAINPAGE = @top_srcdir@/README.md
-- 
2.9.3



More information about the wayland-devel mailing list