[Spice-commits] 2 commits - docs/manual

Marc-André Lureau elmarco at kemper.freedesktop.org
Wed Mar 19 06:02:17 PDT 2014


 docs/manual/Makefile.am         |   44 ++++++++++++++++------------------------
 docs/manual/SpiceUserManual.xml |   24 ++++++++++-----------
 2 files changed, 29 insertions(+), 39 deletions(-)

New commits:
commit e044cfca1e5440c576f2108356971de0b88649dc
Author: Marc-André Lureau <marcandre.lureau at gmail.com>
Date:   Fri Mar 14 14:37:44 2014 +0100

    build-sys: simplify manual html generation

diff --git a/docs/manual/Makefile.am b/docs/manual/Makefile.am
index 75cc4f7..e8856a6 100644
--- a/docs/manual/Makefile.am
+++ b/docs/manual/Makefile.am
@@ -1,38 +1,30 @@
-SUFFIXES = .xml .html .txt .1
+all: html
+.PHONY: html
 
 # apparently, xmlto does not support validation of docbook5 docs
 # that's why it's disabled with --skip-validation
-.xml.html:
-	$(AM_V_GEN)$(XMLTO) --skip-validation -o html xhtml $<
+XMLTO_FLAGS = --skip-validation
 
-.xml.1:
-	$(AM_V_GEN)$(XMLTO) --skip-validation -o man man $<
+XMLDOC =					\
+	SpiceUserManual-Basics.xml		\
+	SpiceUserManual-Guest.xml		\
+	SpiceUserManual-Installation.xml	\
+	SpiceUserManual-Introduction.xml	\
+	SpiceUserManual-References.xml		\
+	SpiceUserManual.xml			\
+	$(NULL)
 
-.xml.txt:
-	$(AM_V_GEN)$(XMLTO) --skip-validation -o txt txt $<
+html-stamp: $(XMLDOC)
+	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) -o html xhtml $(srcdir)/SpiceUserManual.xml
+	touch $@
 
-all: allhtml manpages
-
-XMLMAN =
-XMLDOC = \
-	SpiceUserManual-Basics.xml \
-	SpiceUserManual-Guest.xml \
-	SpiceUserManual-Installation.xml \
-	SpiceUserManual-Introduction.xml \
-	SpiceUserManual-References.xml \
-	SpiceUserManual.xml
-XMLALL = $(XMLMAN) $(XMLDOC)
-SOURCES = $(XMLALL) $(TXTDOC)
-
-allhtml: $(XMLALL:.xml=.html)
-
-manpages: $(XMLMAN:.xml=.1)
+html: html-stamp
 
 # Control what goes in the distribution tarball.
 # We include all of the XML, and also generated HTML pages
 # so people working from the distribution tarball won't need xmlto.
-EXTRA_DIST = $(SOURCES) html
+EXTRA_DIST = $(XMLDOC) html html-stamp
 
 clean-local:
-	rm -fr html $(XMLMAN:.xml=.1)
-
+	rm -fr html
+	rm -f *-stamp
commit f8bc446b76420294e10436b26a6c9fb275125a82
Author: Marc-André Lureau <marcandre.lureau at gmail.com>
Date:   Fri Mar 14 14:34:29 2014 +0100

    SpiceUserManual.xml: small clean-ups
    
    Remove some non-conventional/non-freesoftware editor-specific lines.
    
    Remove trailing whitespaces
    
    Get rid of DTD, which is too strict for docbook, see also:
    http://docbook.org/tdg5/en/html/ch02.html
    
    This get rids of the following warning/error:
    
    I/O error : Attempt to load network entity
    http://docbook.org/xml/5.0/dtd/docbook.dtd
    /home/elmarco/src/spice/spice-master/docs/manual/SpiceUserManual.xml:4:
    warning: failed to load external entity
    "http://docbook.org/xml/5.0/dtd/docbook.dtd"
              "http://docbook.org/xml/5.0/dtd/docbook.dtd">
                                                           ^

diff --git a/docs/manual/SpiceUserManual.xml b/docs/manual/SpiceUserManual.xml
index d710636..875a0da 100644
--- a/docs/manual/SpiceUserManual.xml
+++ b/docs/manual/SpiceUserManual.xml
@@ -1,14 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rng" type="xml"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0//EN"
-          "http://docbook.org/xml/5.0/dtd/docbook.dtd">
-<book xmlns="http://docbook.org/ns/docbook" 
+
+<book xmlns="http://docbook.org/ns/docbook"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
         xml:lang="en">
     <info>
         <title>Spice User Manual</title>
-        
+
         <authorgroup>
             <author>
                 <personname>Lubos Kocman</personname>
@@ -27,7 +25,7 @@
                 <email>cfergeau at redhat.com</email>
             </author>
         </authorgroup>
-        
+
         <copyright>
             <year>2009</year>
             <year>2010</year>
@@ -35,18 +33,18 @@
             <year>2013</year>
             <holder>Red Hat, Inc.</holder>
         </copyright>
-        
+
         <legalnotice>
             <para>
-                Licensed under a Creative Commons Attribution-Share Alike 3.0 United States License 
+                Licensed under a Creative Commons Attribution-Share Alike 3.0 United States License
                 (see <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://creativecommons.org/licenses/by-sa/3.0/us/legalcode">http://creativecommons.org/licenses/by-sa/3.0/us/legalcode</link>).
             </para>
         </legalnotice>
         <releaseinfo>Draft 6</releaseinfo>
         <pubdate>Built on <?dbtimestamp format="Y-m-d H:M:S"?></pubdate>
-        
+
         <cover>
-            
+
             <mediaobject>
                 <imageobject>
                     <imagedata fileref="resources/pepper.png" format="png">
@@ -59,13 +57,13 @@
                 </imageobject>
             </mediaobject>
         </cover>
-        
+
     </info>
-    
+
     <xi:include href="SpiceUserManual-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     <xi:include href="SpiceUserManual-Basics.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     <xi:include href="SpiceUserManual-References.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     <xi:include href="SpiceUserManual-Guest.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     <xi:include href="SpiceUserManual-Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-       
+
 </book>


More information about the Spice-commits mailing list