[PATCH 3/5 v4] Show Xserver release/version date in DIX & DDX docs

Alan Coopersmith alan.coopersmith at oracle.com
Tue May 18 15:51:20 PDT 2010


Uses a catalog file to provide the path to an entity file in a
different directory than the xml sources.

Signed-off-by: Alan Coopersmith <alan.coopersmith at oracle.com>
---

Back to using xmlto, thanks to Dan's suggestion on how to make it work
with entity files in other directories.

 configure.ac                   |    2 ++
 doc/xml/.gitignore             |    5 +++++
 doc/xml/Xserver-spec.xml       |    4 +++-
 doc/xml/xmlrules.in            |   15 ++++++++++++---
 doc/xml/xserver.ent.in         |    3 +++
 hw/xfree86/doc/sgml/DESIGN.xml |    4 +++-
 6 files changed, 28 insertions(+), 5 deletions(-)
 create mode 100644 doc/xml/.gitignore
 create mode 100644 doc/xml/xserver.ent.in

diff --git a/configure.ac b/configure.ac
index e981feb..d288fe9 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2139,6 +2139,7 @@ AC_TRY_COMPILE([
 
 AC_DEFINE_DIR(PROJECTROOT, prefix, [Overall prefix])
 
+AC_SUBST([RELEASE_DATE])
 BUILD_DATE="`date +'%Y%m%d'`"
 AC_SUBST([BUILD_DATE])
 BUILD_TIME="`date +'1%H%M%S'`"
@@ -2162,6 +2163,7 @@ dbe/Makefile
 dix/Makefile
 doc/Makefile
 doc/xml/Makefile
+doc/xml/xserver.ent
 fb/Makefile
 record/Makefile
 config/Makefile
diff --git a/doc/xml/.gitignore b/doc/xml/.gitignore
new file mode 100644
index 0000000..4961738
--- /dev/null
+++ b/doc/xml/.gitignore
@@ -0,0 +1,5 @@
+#		Add & Override for this directory and its subdirectories
+xserver.ent
+Xserver-spec.html
+Xserver-spec.pdf
+Xserver-spec.txt
diff --git a/doc/xml/Xserver-spec.xml b/doc/xml/Xserver-spec.xml
index 8691f18..4b1259b 100644
--- a/doc/xml/Xserver-spec.xml
+++ b/doc/xml/Xserver-spec.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+ <!ENTITY % defs SYSTEM "file:///xserver.ent"> %defs;
 ]>
 
 <article>
@@ -38,7 +39,8 @@
       <affiliation><orgname>X.org Foundation and Hewlett Packard</orgname></affiliation>
     </author>
     <publisher><publishername>The X.Org Foundation</publishername></publisher>
-    <pubdate>2004</pubdate>
+    <pubdate>&xserver.reldate;</pubdate>
+    <releaseinfo>X server version &xserver.version;</releaseinfo>
     <title>Definition of the Porting Layer for the X v11 Sample Server</title>
     <titleabbrev>X Porting Layer</titleabbrev>
     <revhistory>
diff --git a/doc/xml/xmlrules.in b/doc/xml/xmlrules.in
index a4d43f9..1be3691 100644
--- a/doc/xml/xmlrules.in
+++ b/doc/xml/xmlrules.in
@@ -36,24 +36,33 @@ BUILT_DOC_FILES =
 
 SUFFIXES = .xml .txt .html .pdf
 
+XML_ENT_DIR = $(abs_top_builddir)/doc/xml
+XMLTO_FLAGS = --searchpath $(XML_ENT_DIR)
+
 if HAVE_XMLTO
 BUILT_DOC_FILES += $(TXT_FILES)
 .xml.txt:
 	@rm -f $@
-	$(AM_V_GEN)$(XMLTO) txt $<
+	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) txt $<
 
 BUILT_DOC_FILES += $(HTML_FILES)
 .xml.html:
 	@rm -f $@
-	$(AM_V_GEN)$(XMLTO) xhtml-nochunks $<
+	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks $<
 
 if HAVE_FOP
 BUILT_DOC_FILES += $(PDF_FILES)
 .xml.pdf:
 	@rm -f $@
-	$(AM_V_GEN)$(XMLTO) --with-fop pdf $<
+	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop pdf $<
 endif
 
 endif
 
 CLEAN_DOC_FILES = $(TXT_FILES) $(HTML_FILES) $(PDF_FILES)
+
+# All the files we build depend on the entities
+$(BUILT_DOC_FILES): $(XML_ENT_DIR)/xserver.ent
+
+$(XML_ENT_DIR)/xserver.ent:
+	(cd $(XML_ENT_DIR) && $(MAKE) $(AM_MAKEFLAGS) $(@F))
diff --git a/doc/xml/xserver.ent.in b/doc/xml/xserver.ent.in
new file mode 100644
index 0000000..5cb4e23
--- /dev/null
+++ b/doc/xml/xserver.ent.in
@@ -0,0 +1,3 @@
+<!-- shared -*-xml-*- entity definitions for the X server documentation -->
+<!ENTITY xserver.version "@PACKAGE_VERSION@">
+<!ENTITY xserver.reldate "@RELEASE_DATE@">
diff --git a/hw/xfree86/doc/sgml/DESIGN.xml b/hw/xfree86/doc/sgml/DESIGN.xml
index 0613359..d0e8542 100644
--- a/hw/xfree86/doc/sgml/DESIGN.xml
+++ b/hw/xfree86/doc/sgml/DESIGN.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+ <!ENTITY % defs SYSTEM "file:///xserver.ent"> %defs;
  <!-- config file keyword markup -->
  <!-- specific config file keywords -->
  <!ENTITY k.device "<emphasis>Device</emphasis>">
@@ -29,7 +30,8 @@
       </othercredit>
     </authorgroup>
 
-    <pubdate>19 December 2003</pubdate>
+    <pubdate>&xserver.reldate;</pubdate>
+    <releaseinfo>Xorg server version &xserver.version;</releaseinfo>
 
   </articleinfo>
 
-- 
1.5.6.5



More information about the xorg-devel mailing list