From e812e2722ec5c535065ed7d7176e7c963e0b0f8d Mon Sep 17 00:00:00 2001
From: Russ Allbery <rra@debian.org>
Date: Fri, 2 Mar 2012 18:41:34 -0800
Subject: [PATCH] Add Policy version to DocBook subdocuments, fix whitespace

* Embed the Debian Policy version and build date in the debconf
  specification and the copyright-format document.  We'll make
  non-normative changes without updating other version numbers, and it's
  good to know which version one is looking at.
* Fix some whitespace issues in the debconf specification articleinfo.
---
 .gitignore                                |  2 ++
 copyright-format/copyright-format-1.0.xml |  5 ++-
 debconf_spec/debconf_specification.xml    | 43 +++++++----------------
 debian/changelog                          |  5 +++
 debian/rules                              | 22 ++++++++++--
 5 files changed, 42 insertions(+), 35 deletions(-)

diff --git a/.gitignore b/.gitignore
index 8879931..5c80ed5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,8 +1,10 @@
 /Process.html
 /README.html
 /copyright-format/copyright-format-1.0.html
+/copyright-format/version.xml
 /debconf_spec/debconf_specification.html
 /debconf_spec/debconf_specification.txt.gz
+/debconf_spec/include/version.xml
 /debian/files
 /debian/tmp/
 /menu-policy.html/
diff --git a/copyright-format/copyright-format-1.0.xml b/copyright-format/copyright-format-1.0.xml
index afa0c02..217e8dd 100644
--- a/copyright-format/copyright-format-1.0.xml
+++ b/copyright-format/copyright-format-1.0.xml
@@ -3,7 +3,9 @@
     href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"?>
 
 <!DOCTYPE article PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
-    'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd'>
+    'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
+<!ENTITY % versiondata SYSTEM "version.xml"> %versiondata;
+]>
 
 <article class="specification" lang="en" id="copyright-format-1.0">
   <articleinfo>
@@ -11,6 +13,7 @@
       Machine-readable <filename>debian/copyright</filename> file
     </title>
     <subtitle>Version 1.0</subtitle>
+    <releaseinfo>Debian Policy &version;, &date;</releaseinfo>
     <legalnotice>
       <para>
         Copying and distribution of this file, with or without modification,
diff --git a/debconf_spec/debconf_specification.xml b/debconf_spec/debconf_specification.xml
index a163213..638688a 100644
--- a/debconf_spec/debconf_specification.xml
+++ b/debconf_spec/debconf_specification.xml
@@ -5,54 +5,35 @@
 <!ENTITY command_list SYSTEM "include/commands.xml">
 <!ENTITY priority_table SYSTEM "include/priorities.xml">
 <!ENTITY type_table SYSTEM "include/types.xml">
+<!ENTITY % versiondata SYSTEM "include/version.xml"> %versiondata;
 ]>
 <article>
 
   <articleinfo>
     <title>Configuration management</title>
     <subtitle>Protocol version 2.1</subtitle>
-    <releaseinfo>Revision 7.1</releaseinfo>
+    <releaseinfo>Revision 7.1, Debian Policy &version;, &date;</releaseinfo>
     <author>
-      <firstname>
-        Wichert
-      </firstname>
-      <surname>
-        Akkerman
-      </surname>
+      <firstname>Wichert</firstname>
+      <surname>Akkerman</surname>
       <affiliation>
-        <orgname>
-	  The Debian Project
-	</orgname>
+        <orgname>The Debian Project</orgname>
 	<address><email>wakkerma@debian.org</email></address>
       </affiliation>
     </author>
     <author>
-      <firstname>
-        Joey
-      </firstname>
-      <surname>
-        Hess
-      </surname>
+      <firstname>Joey</firstname>
+      <surname>Hess</surname>
       <affiliation>
-        <orgname>
-	  The Debian Project
-	</orgname>
+        <orgname>The Debian Project</orgname>
 	<address><email>joeyh@debian.org</email></address>
       </affiliation>
     </author>
     <copyright>
-      <year>
-        1998
-      </year>
-      <year>
-        1999
-      </year>
-      <year>
-        2000
-      </year>
-      <holder>
-        Wichert Akkerman and Joey Hess
-      </holder>
+      <year>1998</year>
+      <year>1999</year>
+      <year>2000</year>
+      <holder>Wichert Akkerman and Joey Hess</holder>
     </copyright>
     <legalnotice>
       <para>
diff --git a/debian/changelog b/debian/changelog
index 566a8c5..7aa9c66 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -24,6 +24,11 @@ debian-policy (3.9.3.1) UNRELEASED; urgency=low
     Morris.  (Closes: #658009)
   * Fix the legal notice in copyright-format to not refer to a nonexistent
     copyright notice.
+  * Embed the Debian Policy version and build date in the debconf
+    specification and the copyright-format document.  We'll make
+    non-normative changes without updating other version numbers, and it's
+    good to know which version one is looking at.
+  * Fix some whitespace issues in the debconf specification articleinfo.
   * Install the HTML version of upgrading-checklist in the policy.html
     directory as upgrading-checklist.html so that it can be deployed on
     www.debian.org in a way that will allow links to Policy sections to
diff --git a/debian/rules b/debian/rules
index a3950ca..1f69ddb 100755
--- a/debian/rules
+++ b/debian/rules
@@ -56,7 +56,8 @@ FILES_TO_CLEAN	:= $(SGML_FILES:=.txt) $(SGML_FILES:=.txt.gz)		\
 		   $(ORG_FILES:=.html) $(ORG_FILES:=.txt)		\
 		   policy.pdf.gz policy.ps.gz				\
 		   policy.pdf policy.ps policy.tpt policy.txt		\
-		   version.ent						\
+		   copyright-format/version.xml				\
+		   debconf_spec/include/version.xml version.ent		\
 		   copyright-format.xml.tar.gz				\
 		   debconf_specification.xml.tar.gz			\
 		   debian/files
@@ -68,7 +69,8 @@ mkdir   := install -d -o root -g root -m 755
 
 all build build-indep: stamp-build
 build-arch:
-stamp-build: version.ent
+stamp-build: version.ent copyright-format/version.xml \
+	     debconf_spec/include/version.xml
 	$(MAKE) $(SGML_FILES:=.sgml.validate) \
 		$(SGML_FILES:=.html.tar.gz) \
                 $(SGML_FILES:=-1.html) \
@@ -84,11 +86,25 @@ stamp-build: version.ent
 		tar -zcf ../debconf_specification.xml.tar.gz *
 	touch stamp-build
 
-configure: version.ent
+# Create the version files for inclusion in the various documents.  We want
+# to put the Policy version and date in each document, even if they
+# separately have their own versions.
+configure: version.ent copyright-format/version.xml \
+	   debconf_spec/include/version.xml
 version.ent: debian/changelog
 	rm -f $@
 	echo "<!entity version \"$(version)\">" >> $@
 	echo "<!entity date    \"$(date)\">"	>> $@
+copyright-format/version.xml: debian/changelog
+	rm -f $@
+	echo '<?xml version="1.0" standalone="no"?>' >  $@
+	echo '<!ENTITY version "$(version)">'        >> $@
+	echo '<!ENTITY date    "$(date)">'           >> $@
+debconf_spec/include/version.xml: debian/changelog
+	rm -f $@
+	echo '<?xml version="1.0" standalone="no"?>' >  $@
+	echo '<!ENTITY version "$(version)">'        >> $@
+	echo '<!ENTITY date    "$(date)">'           >> $@
 
 clean:
 	rm -f $(STAMPS_TO_CLEAN)
-- 
2.39.2