]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Create html documentation even if XHTML1 DTD is not available to validate
authorIan Campbell <ian.campbell@citrix.com>
Fri, 28 Nov 2014 14:36:18 +0000 (14:36 +0000)
committerMichal Privoznik <mprivozn@redhat.com>
Thu, 4 Dec 2014 10:57:16 +0000 (11:57 +0100)
On a Debian system lacking the w3c-dtd-xhtml package the build fails
with:

        $ make -C docs/ formatcaps.html
        make: Entering directory '/local/scratch/ianc/devel/libvirt.git/docs'
        Generating formatcaps.html.tmp
        I/O error : Attempt to load network entity http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd
        formatcaps.html.in:2: warning: failed to load external entity "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
        C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
                                                                                       ^
        I/O error : Attempt to load network entity http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd
        ../docs/sitemap.html.in:2: warning: failed to load external entity "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
        C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
                                                                                       ^
        missing XHTML1 DTD
        rm formatcaps.html.tmp
        make: Leaving directory '/local/scratch/ianc/devel/libvirt.git/docs'
        $ ls docs/formatcaps*
        docs/formatcaps.html.in

https://www.redhat.com/archives/libvir-list/2009-November/msg00413.html
suggests that the XHTML1 DTD should not be a hard requirement and the
docs should be generated but not validated if it is not available.

Therefore when the DTD is not available arrange for the .html.tmp file
to be propagated to the .html output.

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Cc: Daniel Veillard <veillard@redhat.com>
docs/Makefile.am

index d62482710ff475d75e482db7a72528f6b8cab438..a497256307b714a2e274cea4421dc465b1d58036 100644 (file)
@@ -235,7 +235,7 @@ internals/%.html.tmp: internals/%.html.in subsite.xsl page.xsl sitemap.html.in
          SGML_CATALOG_FILES='$(XML_CATALOG_FILE)' \
          $(XMLLINT) --catalogs --nonet --format --valid $< > $(srcdir)/$@ \
          || { rm $(srcdir)/$@ && exit 1; }; \
-         else echo "missing XHTML1 DTD" ; fi ; fi
+         else echo "missing XHTML1 DTD"; cat $< > $(srcdir)/$@ ; fi ; fi
 
 %.php.tmp: %.php.in site.xsl page.xsl sitemap.html.in
        @if [ -x $(XSLTPROC) ] ; then \
@@ -263,7 +263,7 @@ html/index.html: libvirt-api.xml newapi.xsl page.xsl sitemap.html.in
            > /dev/null ; then \
          SGML_CATALOG_FILES='$(XML_CATALOG_FILE)' \
          $(XMLLINT) --catalogs --nonet --valid --noout $(srcdir)/html/*.html ; \
-         else echo "missing XHTML1 DTD" ; fi ; fi
+         else echo "missing XHTML1 DTD"; cat $< > $(srcdir)/$@ ; fi ; fi
 
 $(addprefix $(srcdir)/,$(devhelphtml)): $(srcdir)/libvirt-api.xml $(devhelpxsl)
        $(AM_V_GEN)if [ -x $(XSLTPROC) ] ; then \