doc-xml-version-generation-20090521

LICENSE MIT

Replace version info in the DocBook files with a new ENTITY "version"
associated with a local "version.xml" file which contain a <revision>
tag for the current release.

The version.xml file should be autogenerated by the Makefile system.

diff --git a/doc/xml/AdminGuide/NTMakefile b/doc/xml/AdminGuide/NTMakefile
index cb2f49a..faf0627 100644 (file)
--- a/doc/xml/AdminGuide/NTMakefile
+++ b/doc/xml/AdminGuide/NTMakefile
@@ -25,6 +25,7 @@
 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+VERSFILE = version
 !INCLUDE ..\..\..\src\config\NTMakefile.$(SYS_NAME)
 !INCLUDE ..\..\..\src\config\NTMakefile.version
 
@@ -61,7 +62,8 @@ XMLSRCS = \
         auagd022.xml \
         auagd023.xml \
         auagd024.xml \
-        auagd025.xml
+        auagd025.xml \
+        $(VERSFILE).xml
 
 index.html: $(XMLSRCS)
         @echo Building OpenAFS Administrator Guide in HTML format
@@ -80,3 +82,4 @@ install: htmlhelp.chm index.html
 clean::
         $(DEL) *.html
         $(DEL) htmlhelp.chm
+        $(DEL) $(VERSFILE).xml

diff --git a/doc/xml/AdminGuide/auagd000.xml b/doc/xml/AdminGuide/auagd000.xml
index e923216..1a1faf6 100644 (file)
--- a/doc/xml/AdminGuide/auagd000.xml
+++ b/doc/xml/AdminGuide/auagd000.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.3//EN"
         "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
 <!ENTITY preface SYSTEM "auagd005.xml">
 <!ENTITY chapter1 SYSTEM "auagd006.xml">
 <!ENTITY chapter2 SYSTEM "auagd007.xml">
@@ -23,12 +24,10 @@
 <!ENTITY appendixC SYSTEM "auagd024.xml">
 <!ENTITY appendixD SYSTEM "auagd025.xml">
 ]>
-<book label="Version M.m">
+<book>
   <bookinfo>
     <title>OpenAFS Administration Guide</title>
 
-    <subtitle>Version M.m</subtitle>
-
     <copyright>
       <year>2000</year>
 
@@ -36,14 +35,8 @@
     </copyright>
 
     <revhistory>
-      <revision>
-        <revnumber>M.m</revnumber>
-
-        <date>May 2008</date>
-
-        <revremark>First OpenAFS Edition</revremark>
-      </revision>
-
+      &version;
+                                  
       <revision>
         <revnumber>3.6</revnumber>
 

diff --git a/doc/xml/QuickStartUnix/NTMakefile b/doc/xml/QuickStartUnix/NTMakefile
index a135ac1..887d56d 100644 (file)
--- a/doc/xml/QuickStartUnix/NTMakefile
+++ b/doc/xml/QuickStartUnix/NTMakefile
@@ -25,6 +25,7 @@
 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+VERSFILE = version
 !INCLUDE ..\..\..\src\config\NTMakefile.$(SYS_NAME)
 !INCLUDE ..\..\..\src\config\NTMakefile.version
 
@@ -47,7 +48,8 @@ XMLSRCS = \
         auqbg006.xml \
         auqbg007.xml \
         auqbg008.xml \
-        appendix.xml
+        appendix.xml \
+        $(VERSFILE).xml
 
 index.html: $(XMLSRCS)
         @echo Building Unix Quick Start Guide in HTML format
@@ -66,3 +68,4 @@ install: htmlhelp.chm index.html
 clean::
         $(DEL) *.html
         $(DEL) htmlhelp.chm
+        $(DEL) $(VERSFILE).xml

diff --git a/doc/xml/QuickStartUnix/auqbg000.xml b/doc/xml/QuickStartUnix/auqbg000.xml
index ec8a1c2..30bc262 100644 (file)
--- a/doc/xml/QuickStartUnix/auqbg000.xml
+++ b/doc/xml/QuickStartUnix/auqbg000.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.3//EN"
        "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
 <!ENTITY preface SYSTEM "auqbg003.xml">
 <!ENTITY chapter1 SYSTEM "auqbg004.xml">
 <!ENTITY chapter2 SYSTEM "auqbg005.xml">
@@ -14,8 +15,6 @@
   <bookinfo>
     <title>OpenAFS Quick Start Guide for UNIX</title>
 
-    <subtitle>Version 1.4.10</subtitle>
-
     <copyright>
       <year>2000-2009</year>
       <holder>IBM Corporation and other contributors. All Rights Reserved</holder>
@@ -27,10 +26,7 @@
     </legalnotice>
 
     <revhistory>
-      <revision>
-        <revnumber>1.4.10</revnumber>
-        <date>May 2009</date>
-      </revision>
+        &version;
     </revhistory>
 
     <abstract>

diff --git a/doc/xml/UserGuide/NTMakefile b/doc/xml/UserGuide/NTMakefile
index ffb39b0..8481d58 100644 (file)
--- a/doc/xml/UserGuide/NTMakefile
+++ b/doc/xml/UserGuide/NTMakefile
@@ -25,6 +25,7 @@
 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+VERSFILE = version
 !INCLUDE ..\..\..\src\config\NTMakefile.$(SYS_NAME)
 !INCLUDE ..\..\..\src\config\NTMakefile.version
 
@@ -50,7 +51,8 @@ XMLSRCS = \
         auusg009.xml \
         auusg010.xml \
         auusg011.xml \
-        auusg012.xml 
+        auusg012.xml \
+        $(VERSFILE).xml
 
 index.html: $(XMLSRCS)
         @echo Building OpenAFS User Guide in HTML format
@@ -68,4 +70,5 @@ install: htmlhelp.chm index.html
 
 clean::
         $(DEL) *.html
-        $(DEL) htmlhelp.chm
\ No newline at end of file
+        $(DEL) htmlhelp.chm
+        $(DEL) $(VERSFILE).xml

diff --git a/doc/xml/UserGuide/auusg000.xml b/doc/xml/UserGuide/auusg000.xml
index 3f4e163..d1265d3 100644 (file)
--- a/doc/xml/UserGuide/auusg000.xml
+++ b/doc/xml/UserGuide/auusg000.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.3//EN"
        "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
 <!ENTITY preface SYSTEM "auusg003.xml">
 <!ENTITY chapter1 SYSTEM "auusg004.xml">
 <!ENTITY chapter2 SYSTEM "auusg005.xml">
@@ -17,8 +18,6 @@
   <bookinfo>
     <title>OpenAFS User Guide</title>
 
-    <subtitle>Version M.n</subtitle>
-
     <copyright>
       <year>2000</year>
 
@@ -26,13 +25,7 @@
     </copyright>
 
     <revhistory>
-      <revision>
-        <revnumber>M.n</revnumber>
-
-        <date>May 2008</date>
-
-        <revremark>First OpenAFS Edition</revremark>
-      </revision>
+      &version;
 
       <revision>
         <revnumber>3.6</revnumber>