From ff9bbffcd9923677b78ad61623ce44c3b4f206a3 Mon Sep 17 00:00:00 2001 From: Justin Clift Date: Wed, 27 Oct 2010 02:07:00 +1100 Subject: [PATCH] docs: make the location of the xml catalog file a configure option The default location for the XML catalog file, /etc/xml/catalog, used when validating the generated html docs, isn't correct for MacOS X. This commit adds an option to the configure script, allowing the default to be overridden: --with-xml-catalog-file=/path/to/xml/catalog/file --- configure.ac | 20 +++++++++++++++----- docs/Makefile.am | 10 ++++++---- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/configure.ac b/configure.ac index e41f2b5bd0..272f12fcb2 100644 --- a/configure.ac +++ b/configure.ac @@ -171,6 +171,15 @@ AC_ARG_WITH([html-subdir], [AC_HELP_STRING([--with-html-subdir=path], [HTML_DIR="$HTML_DIR/\$(PACKAGE)-\$(VERSION)/html"]) AC_SUBST([HTML_DIR]) +dnl Specific XML catalog file for validation of generated html +AC_ARG_WITH([xml-catalog-file], + [AC_HELP_STRING([--with-xml-catalog-file=path], + [path to XML catalog file for validating + generated html, default /etc/xml/catalog])], + [XML_CATALOG_FILE=$withval], + [XML_CATALOG_FILE='/etc/xml/catalog']) +AC_SUBST([XML_CATALOG_FILE]) + dnl if --prefix is /usr, don't use /usr/var for localstatedir dnl or /usr/etc for sysconfdir dnl as this makes a lot of things break in testing situations @@ -2416,11 +2425,12 @@ AC_MSG_NOTICE([ Alloc OOM: $enable_oom]) AC_MSG_NOTICE([]) AC_MSG_NOTICE([Miscellaneous]) AC_MSG_NOTICE([]) -AC_MSG_NOTICE([ Debug: $enable_debug]) -AC_MSG_NOTICE([ Warnings: $enable_compile_warnings]) -AC_MSG_NOTICE([ Readline: $lv_use_readline]) -AC_MSG_NOTICE([ Python: $with_python]) -AC_MSG_NOTICE([ DTrace: $with_dtrace]) +AC_MSG_NOTICE([ Debug: $enable_debug]) +AC_MSG_NOTICE([ Warnings: $enable_compile_warnings]) +AC_MSG_NOTICE([ Readline: $lv_use_readline]) +AC_MSG_NOTICE([ Python: $with_python]) +AC_MSG_NOTICE([ DTrace: $with_dtrace]) +AC_MSG_NOTICE([ XML Catalog: $XML_CATALOG_FILE]) AC_MSG_NOTICE([]) AC_MSG_NOTICE([Privileges]) AC_MSG_NOTICE([]) diff --git a/docs/Makefile.am b/docs/Makefile.am index 3b3b4a0951..b28e04e0a4 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -123,10 +123,11 @@ todo: %.html: %.html.tmp @if test -x $(XMLLINT) && test -x $(XMLCATALOG) ; then \ - if $(XMLCATALOG) /etc/xml/catalog \ + if $(XMLCATALOG) '$(XML_CATALOG_FILE)' \ "-//W3C//DTD XHTML 1.0 Strict//EN" > /dev/null ; then \ echo "Validating $@" ; \ - $(XMLLINT) --nonet --format --valid $< > $@ \ + SGML_CATALOG_FILES='$(XML_CATALOG_FILE)' \ + $(XMLLINT) --catalogs --nonet --format --valid $< > $@ \ || { rm $@ && exit 1; }; \ else echo "missing XHTML1 DTD" ; fi ; fi @@ -136,10 +137,11 @@ html/index.html: libvirt-api.xml newapi.xsl page.xsl sitemap.html.in echo "Rebuilding the HTML pages from the XML API" ; \ $(XSLTPROC) --nonet $(srcdir)/newapi.xsl libvirt-api.xml ; fi -@if test -x $(XMLLINT) && test -x $(XMLCATALOG) ; then \ - if $(XMLCATALOG) /etc/xml/catalog "-//W3C//DTD XHTML 1.0 Strict//EN" \ + if $(XMLCATALOG) '$(XML_CATALOG_FILE)' "-//W3C//DTD XHTML 1.0 Strict//EN" \ > /dev/null ; then \ echo "Validating the resulting XHTML pages" ; \ - $(XMLLINT) --nonet --valid --noout html/*.html ; \ + SGML_CATALOG_FILES='$(XML_CATALOG_FILE)' \ + $(XMLLINT) --catalogs --nonet --valid --noout html/*.html ; \ else echo "missing XHTML1 DTD" ; fi ; fi $(addprefix $(srcdir)/,$(devhelphtml)): $(srcdir)/libvirt-api.xml $(devhelpxsl)