[PATCH util-macros] Add XORG_WITH_XMLTO to factorize xmlto tests.

Gaetan Nadon memsize at videotron.ca
Tue Jan 12 16:08:49 PST 2010

From: Matthieu Herrb <matthieu.herrb at laas.fr>

This also allow to configure with --without-xmlto to ignore
a 3rd party xmlto tool on systems that normally don't have it,
in order to have reproducable builds.

Reviewed-by: Rémi Cardona <remi at gentoo.org>
Signed-off-by: Matthieu Herrb <matthieu.herrb at laas.fr>
Signed-off-by: Gaetan Nadon <memsize at videotron.ca>
 xorg-macros.m4.in |   51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 51 insertions(+), 0 deletions(-)

diff --git a/xorg-macros.m4.in b/xorg-macros.m4.in
index db2a62d..b226262 100644
--- a/xorg-macros.m4.in
+++ b/xorg-macros.m4.in
@@ -310,6 +310,57 @@ AC_SUBST(MAKE_PDF)
+# ----------------
+# Minimum version: 1.5.0
+# Documentation tools are not always available on all platforms and sometimes
+# not at the appropriate level. This macro enables a module to test for the
+# presence of the tool and obtain it's path in separate variables. Coupled with
+# the --with-xmlto option, it allows maximum flexibilty in making decisions
+# as whether or not to use the xmlto package.
+# Interface to module:
+# HAVE_XMLTO: 	used in makefiles to conditionally generate documentation
+# XMLTO:	returns the path of the xmlto program found
+#		returns the path set by the user in the environment
+# --with-xmlto:	'yes' user instructs the module to use xmlto
+#		'no' user instructs the module not to use xmlto
+# If the user sets the value of XMLTO, AC_PATH_PROG skips testing the path.
+AC_ARG_VAR([XMLTO], [Path to xmlto command])
+	AS_HELP_STRING([--with-xmlto],
+	   [Use xmlto to regenerate documentation (default: yes, if installed)]),
+	   [use_xmlto=$withval], [use_xmlto=auto])
+if test "x$use_xmlto" = x"auto"; then
+   AC_PATH_PROG([XMLTO], [xmlto])
+   if test "x$XMLTO" = "x"; then
+        AC_MSG_WARN([xmlto not found - documentation targets will be skipped])
+	have_xmlto=no
+   else
+        have_xmlto=yes
+   fi
+elif test "x$use_xmlto" = x"yes" ; then
+   AC_PATH_PROG([XMLTO], [xmlto])
+   if test "x$XMLTO" = "x"; then
+        AC_MSG_WARN([--with-xmlto=yes specified but xmlto not found in PATH])
+   fi
+   have_xmlto=yes
+elif test "x$use_xmlto" = x"no" ; then
+   if test "x$XMLTO" != "x"; then
+      AC_MSG_WARN([ignoring XMLTO environment variable since --with-xmlto=no was specified])
+   fi
+   have_xmlto=no
+   AC_MSG_ERROR([--with-xmlto expects 'yes' or 'no'])
+AM_CONDITIONAL([HAVE_XMLTO], [test "$have_xmlto" = yes])
 # ----------------------
 # Minimum version: 1.0.0

I took the liberty of submitting version 3 for review.

 New comment section
 Changed my mind about 'yes' + 'missing xmlto' = error. Not for this macro to decide. WARN instead.
 Changed user messages
 Last else simplified: option is not used for xmlto path, the XMLTO env var is. It's 'yes' or 'no'. 
 The behavior of 'yes' and 'auto' is now the same, but it may changed in  the future.

I intend to produce one of asciidoc and doxygen. 

More information about the xorg-devel mailing list