]> git.donarmstrong.com Git - debian/debian-policy.git/commitdiff
* Added doc-base support for all of the HTML docs in the package
authorManoj Srivastava <srivasta@debian.org>
Thu, 16 Jun 2005 05:12:39 +0000 (05:12 +0000)
committerManoj Srivastava <srivasta@debian.org>
Thu, 16 Jun 2005 05:12:39 +0000 (05:12 +0000)
Author: jdg
Date: 2001/05/02 00:26:25
* Added doc-base support for all of the HTML docs in the package
* Added a few more byhand files and rewrote chunks of debian/rules
* I'm pretty sure it won't work first time; it will need some testing
first!  ;-)

git-archimport-id: srivasta@debian.org--etch/debian-policy--devel--3.0--patch-110

debconf-spec.desc [new file with mode: 0644]
debconf_spec/Makefile
debian-menu-policy.desc [new file with mode: 0644]
debian-mime-policy.desc [new file with mode: 0644]
debian-perl-policy.desc [new file with mode: 0644]
debian-policy-process.desc [new file with mode: 0644]
debian-policy.desc
debian/postinst.in
debian/prerm.in
debian/rules

diff --git a/debconf-spec.desc b/debconf-spec.desc
new file mode 100644 (file)
index 0000000..3ddaf7a
--- /dev/null
@@ -0,0 +1,17 @@
+Document: debconf-spec
+Title: Debian Configuration Management Specification
+Author: The Debian Policy Mailing list
+Abstract: This manual describes the package configuration system used
+ by the debconf system, and defines the format of the template and
+ config files which are used.
+Section: Debian
+
+Format: docbook-xml
+Files: /usr/share/doc/debian-policy/debconf_specification.tar.gz
+
+Format: text
+Files: /usr/share/doc/debian-policy/debconf_specification.xml.txt.gz
+
+Format: HTML
+Index: /usr/share/doc/debian-policy/debconf_specification.html
+Files: /usr/share/doc/debian-policy/debconf_specification.html
index 59b0dd7cb0617d725d0b3910aa1a54eaf7a56e7a..a34ade79fdcdab2b15f34883486f0257fedc48f3 100644 (file)
@@ -9,4 +9,4 @@ all: debconf_specification.txt debconf_specification.html
        links -dump $< | perl -pe 's/[\r\0]//g' > $@
 
 clean:
-       rm -f *.css *.html *.txt
+       rm -f *.css *.html *.txt *.txt.gz
diff --git a/debian-menu-policy.desc b/debian-menu-policy.desc
new file mode 100644 (file)
index 0000000..d3eb5c2
--- /dev/null
@@ -0,0 +1,17 @@
+Document: debian-menu-policy
+Title: Debian Menu Policy Manual
+Author: The Debian Policy Mailing list
+Abstract: This manual describes the policy requirements for the Menu
+ system in the Debian GNU/Linux distribution, describing the
+ hierarchical structure of the menu sections.
+Section: Debian
+
+Format: debiandoc-sgml
+Files: /usr/share/doc/debian-policy/menu-policy.sgml.gz
+
+Format: text
+Files: /usr/share/doc/debian-policy/menu-policy.txt.gz
+
+Format: HTML
+Index: /usr/share/doc/debian-policy/menu-policy.html/index.html
+Files: /usr/share/doc/debian-policy/menu-policy.html/*.html
diff --git a/debian-mime-policy.desc b/debian-mime-policy.desc
new file mode 100644 (file)
index 0000000..92c4e4d
--- /dev/null
@@ -0,0 +1,18 @@
+Document: debian-mime-policy
+Title: Debian MIME Policy Manual
+Author: The Debian Policy Mailing list
+Abstract: This manual describes the policy requirements for the MIME
+ system in the Debian GNU/Linux distribution, describing the rules
+ regulating the registration of programs that can handle MIME
+ content.
+Section: Debian
+
+Format: debiandoc-sgml
+Files: /usr/share/doc/debian-policy/mime-policy.sgml.gz
+
+Format: text
+Files: /usr/share/doc/debian-policy/mime-policy.txt.gz
+
+Format: HTML
+Index: /usr/share/doc/debian-policy/mime-policy.html/index.html
+Files: /usr/share/doc/debian-policy/mime-policy.html/*.html
diff --git a/debian-perl-policy.desc b/debian-perl-policy.desc
new file mode 100644 (file)
index 0000000..931e937
--- /dev/null
@@ -0,0 +1,18 @@
+Document: debian-perl-policy
+Title: Debian Perl Policy Manual
+Author: The Debian Policy Mailing list
+Abstract: This manual describes the policy requirements for the Perl
+ system in the Debian GNU/Linux distribution, describing the rules
+ regulating the building and installation of packages providing and
+ using Perl and Perl modules.
+Section: Debian
+
+Format: debiandoc-sgml
+Files: /usr/share/doc/debian-policy/perl-policy.sgml.gz
+
+Format: text
+Files: /usr/share/doc/debian-policy/perl-policy.txt.gz
+
+Format: HTML
+Index: /usr/share/doc/debian-policy/perl-policy.html/index.html
+Files: /usr/share/doc/debian-policy/perl-policy.html/*.html
diff --git a/debian-policy-process.desc b/debian-policy-process.desc
new file mode 100644 (file)
index 0000000..205c4aa
--- /dev/null
@@ -0,0 +1,15 @@
+Document: debian-policy-process
+Title: Debian Policy Process Description
+Author: The Debian Policy Mailing list
+Abstract: This document describes how Debian Policy is developed.
+Section: Debian
+
+Format: debiandoc-sgml
+Files: /usr/share/doc/debian-policy/policy-process.sgml.gz
+
+Format: text
+Files: /usr/share/doc/debian-policy/policy-process.txt.gz
+
+Format: HTML
+Index: /usr/share/doc/debian-policy/policy-process.html/index.html
+Files: /usr/share/doc/debian-policy/policy-process.html/*.html
index f972c4741c48d3d4a66cd66391020b3204d57ca6..2fc28dca6fda1519c0572105c49615660d94e26e 100644 (file)
@@ -5,15 +5,14 @@ Abstract: This manual describes the policy requirements for the Debian
  GNU/Linux distribution. This includes the structure and contents of
  the Debian archive, several design issues of the operating system, as
  well as technical requirements that each package must satisfy to be
- included in the distribution. Also included are ancilliary documents
- and sub policy documentation.  
+ included in the distribution.
 Section: Debian
 
 Format: debiandoc-sgml
 Files: /usr/share/doc/debian-policy/policy.sgml.gz
 
 Format: text
-Files: /usr/share/doc/debian-policy/policy.text.gz
+Files: /usr/share/doc/debian-policy/policy.txt.gz
 
 Format: HTML
 Index: /usr/share/doc/debian-policy/policy.html/index.html
index d2c6f6f82fdde42f6c130ea0fe897b2166839ac1..807be4934568ea39197532b5f68f30c157d5b8d7 100644 (file)
@@ -128,7 +128,12 @@ EOF
 
 
     if [ -x /usr/sbin/install-docs ]; then
-       /usr/sbin/install-docs -i /usr/share/doc-base/$PACKAGE
+       /usr/sbin/install-docs -i /usr/share/doc-base/debian-policy
+       /usr/sbin/install-docs -i /usr/share/doc-base/debian-menu-policy
+       /usr/sbin/install-docs -i /usr/share/doc-base/debian-mime-policy
+       /usr/sbin/install-docs -i /usr/share/doc-base/debian-perl-policy
+       /usr/sbin/install-docs -i /usr/share/doc-base/debian-policy-process
+       /usr/sbin/install-docs -i /usr/share/doc-base/debconf-spec
     fi
 
     # There are three sub-cases:
index 4f1a636e2dbaab0f50c7c5ff54b41e382865c0e6..b4d5ddb8e21c7c3a339ce55d82b0f23ccbd432a0 100644 (file)
@@ -81,7 +81,12 @@ esac
 
 
 if [ -x /usr/sbin/install-docs ]; then
-    /usr/sbin/install-docs -r $package_name
+    /usr/sbin/install-docs -r debian-policy
+    /usr/sbin/install-docs -r debian-menu-policy
+    /usr/sbin/install-docs -r debian-mime-policy
+    /usr/sbin/install-docs -r debian-perl-policy
+    /usr/sbin/install-docs -r debian-policy-process
+    /usr/sbin/install-docs -r debconf-spec
 fi
 
 exit 0
index 69b5dfd1b1b607d19d02a0cec8eb48bc0f8ef9c6..028c067823bf86ef62ab14d6bb853663b34d3418 100755 (executable)
@@ -14,9 +14,9 @@
 ## $Id$
 ###############################################################################
 
-ifdef ARCH
-  ha:=-a$(ARCH)
-endif
+ifdef ARCH
+  ha:=-a$(ARCH)
+endif
 
 # set the dpkg-architecture vars; but we don't use them, so we'll comment out
 # export DEB_BUILD_ARCH      := $(shell dpkg-architecture $(ha) -qDEB_BUILD_ARCH)
@@ -29,31 +29,13 @@ endif
 # export DEB_HOST_GNU_TYPE   := $(shell dpkg-architecture $(ha) -qDEB_HOST_GNU_TYPE)
 
 
-
 # The name of the package (for example, `emacs').
 package := $(shell grep Source debian/control | sed 's/^Source: //')
-arch   := $(shell dpkg --print-installation-architecture)
+# arch := $(shell dpkg --print-installation-architecture)
 date   := $(shell date +"%Y-%m-%d")
 version := $(shell LC_ALL=C dpkg-parsechangelog | \
                   grep ^Version: | sed 's/^Version: *//')
 
-FILES_TO_CLEAN  = debian/files debian/buildinfo  debian/substvars \
-                 debian/postinst debian/prerm \
-                 version.ent  policy.lout policy.lout.ld lout.li \
-                 upgrading-checklist.txt policy.txt.gz \
-                 menu-policy.txt.gz menu-policy.pdf.gz \
-                 perl-policy.txt.gz perl-policy.pdf.gz \
-                 policy-process.txt.gz policy-process.pdf.gz \
-                 mime-policy.txt.gz mime-policy.pdf.gz \
-                  debconf_spec/debconf_specification.html \
-                  debconf_spec/debconf_specification.txt.gz \
-
-STAMPS_TO_CLEAN = stamp-policy stamp-build stamp-configure
-DIRS_TO_CLEAN   = debian/tmp policy.html fhs \
-                 menu-policy.html mime-policy.html \
-                 policy-process.html perl-policy.html
-SGML_FILES      = policy menu-policy mime-policy policy-process perl-policy
-
 # Location of the source dir
 SRCTOP   := $(shell if [ "$$PWD" != "" ]; then echo $$PWD; else pwd; fi;)
 TMPTOP   := $(SRCTOP)/debian/tmp
@@ -61,6 +43,10 @@ DOCDIR         := $(TMPTOP)/usr/share/doc/$(package)
 LIBDIR   := $(TMPTOP)/usr/share/doc-base
 
 
+SGML_FILES      = policy menu-policy mime-policy policy-process perl-policy
+DESC_FILES      = debian-policy debian-menu-policy debian-perl-policy \
+                  debian-mime-policy debian-policy-process debconf-spec
+
 # While we have two versions of the FHS installed in the source package,
 # we need to modify this to handle it.  This is the easiest way to do it.
 # FHS_ARCHIVE  =$(shell ls -1 fhs*.tar.gz)
@@ -71,20 +57,27 @@ FHS_HTML     =fhs-2.1.html.tar.gz
 FHS_FILES    =fhs/fhs.ps fhs/fhs.txt fhs/fhs.pdf
 FHS_BYHAND   =fhs-2.1.html.tar.gz fhs/fhs.txt
 # FSSTND_FILES =FSSTND-FAQ fsstnd-1.2.dvi.gz fsstnd-1.2.ps.gz fsstnd-1.2.txt.gz
-POLICY_FILES =policy.txt.gz policy.sgml virtual-package-names-list.txt \
-             upgrading-checklist.txt libc6-migration.txt version.ent \
-             menu-policy.sgml menu-policy.txt.gz \
-             perl-policy.sgml perl-policy.txt.gz \
-             mime-policy.sgml mime-policy.txt.gz \
-              policy-process.txt.gz policy-process.sgml \
-              debconf_spec/debconf_specification.html \
-              debconf_spec/debconf_specification.txt.gz
-BYHAND_FILES =policy.txt.gz libc6-migration.txt \
-             virtual-package-names-list.txt menu-policy.txt.gz \
-             mime-policy.txt.gz policy.ps.gz policy.pdf.gz \
-              policy.html.tar.gz perl-policy.txt.gz \
-             debconf_spec/debconf_specification.txt.gz \
-             $(FHS_BYHAND)
+POLICY_FILES = $(SGML_FILES:=.sgml) $(SGML_FILES:=.txt.gz) \
+              virtual-package-names-list.txt \
+              upgrading-checklist.txt libc6-migration.txt version.ent \
+               debconf_spec/debconf_specification.html \
+               debconf_spec/debconf_specification.txt.gz
+BYHAND_FILES = $(SGML_FILES:=.txt.gz) $(SGML_FILES:=.html.tar.gz) \
+              debconf_spec/debconf_specification.txt.gz \
+              debconf_spec/debconf_specification.html \
+              libc6-migration.txt virtual-package-names-list.txt \
+              policy.ps.gz policy.pdf.gz \
+              $(FHS_BYHAND)
+
+FILES_TO_CLEAN  = debian/files debian/buildinfo  debian/substvars \
+                 debian/postinst debian/prerm \
+                 version.ent upgrading-checklist.txt \
+                 $(SGML_FILES:=.txt.gz) $(SGML_FILES:=.html.tar.gz) \
+                 policy.pdf.gz policy.ps.gz \
+                 debconf_specification.xml.tar.gz
+
+STAMPS_TO_CLEAN = stamp-policy stamp-build stamp-configure
+DIRS_TO_CLEAN   = debian/tmp fhs $(SGML_FILES:=.html)
 
 
 install_file   = /usr/bin/install -p   -o root -g root  -m  644
@@ -98,14 +91,17 @@ all build: stamp-build
 stamp-build:
        $(checkdir)
        -test -f stamp-configure || $(MAKE) -f debian/rules configure
+       set -e; \
        for file in $(SGML_FILES); do \
          nsgmls -gues $$file.sgml; \
          debiandoc2html $$file.sgml; \
          debiandoc2text $$file.sgml; \
          if [ -f $$file.text ]; then mv $$file.text $$file.txt; fi; \
-         gzip -9f $$file.txt; \
+         gzip -9 $$file.txt; \
+         tar -cf $$file.html.tar $$file.html; \
+         gzip -9 $$file.html.tar; \
        done
-       tar zfx $(FHS_ARCHIVE)
+       tar -zxf $(FHS_ARCHIVE)
        # Need to use a patched tmac.m macro file if we're using a pre-1.16
        # groff; version 1.16 is apparently fixed
        if dpkg --compare-versions $(GROFF_VERSION) lt 1.16; then \
@@ -132,6 +128,7 @@ stamp-configure:
 clean:
 # Undoes the effect of `make -f debian/rules build'.
        $(checkdir)
+       $(MAKE) -C debconf_spec clean
        rm -f  $(FILES_TO_CLEAN) $(STAMPS_TO_CLEAN)
        rm -rf $(DIRS_TO_CLEAN)
        rm -f core `find . \( -name '*.orig' -o -name '*.rej' -o \
@@ -170,29 +167,33 @@ stamp-policy:  build
        $(install_file)     $(FHS_FILES)             $(DOCDIR)/fhs/
        $(install_file)     debian/changelog         $(DOCDIR)/
        # Be more specific with file compression
-       -gzip -q9           $(DOCDIR)/*.txt $(DOCDIR)/*.sgml \
+       -gzip -           $(DOCDIR)/*.txt $(DOCDIR)/*.sgml \
                                $(DOCDIR)/fhs/* $(DOCDIR)/changelog
        $(install_file)     debian/copyright         $(DOCDIR)/
-       $(install_file)     debian-policy.desc       $(LIBDIR)/debian-policy
-       (tar cf -           policy.html) |           (cd $(DOCDIR) && tar xf -)
-       (tar cf -           menu-policy.html) |      (cd $(DOCDIR) && tar xf -)
-       (tar cf -           perl-policy.html) |      (cd $(DOCDIR) && tar xf -)
-       (tar cf -           mime-policy.html) |      (cd $(DOCDIR) && tar xf -)
-       (tar cf -           policy-process.html) |   (cd $(DOCDIR) && tar xf -)
-       tar -C $(DOCDIR)/fhs -zfx $(FHS_HTML)
+       GZIP=-9 tar -C debconf_spec -zcf debconf_specification.xml.tar.gz *
+       $(install_file)     debconf_specification.xml.tar.gz $(DOCDIR)/
+       set -e; \
+        for file in $(DESC_FILES); do \
+         $(install_file) $$file.desc $(LIBDIR)/$$file; \
+       done
+       set -e; \
+       for file in $(SGML_FILES); do \
+         tar -C $(DOCDIR) -zxf $$file.html.tar.gz; \
+       done
+       tar -C $(DOCDIR)/fhs -zxf $(FHS_HTML)
        sed -e 's/#PACKAGE#/$(package)/g' debian/postinst.in > debian/postinst
        sed -e 's/#PACKAGE#/$(package)/g' debian/prerm.in > debian/prerm
        $(install_program)  debian/postinst          debian/tmp/DEBIAN/
        $(install_program)  debian/prerm             debian/tmp/DEBIAN/
        dpkg-gencontrol     -pdebian-policy -Pdebian/tmp -isp
-       chown               -R root.root debian/tmp
+       chown               -R root:root debian/tmp
        chmod               -R go=rX debian/tmp
        dpkg                --build debian/tmp ..
        debiandoc2latexps   policy.sgml
-       gzip -9qvf          policy.ps
+       gzip -9f            policy.ps
        debiandoc2latexpdf  policy.sgml
-       gzip -9qfv          policy.pdf
-       GZIP=-9v tar zcf    policy.html.tar.gz    policy.html
+       gzip -9f            policy.pdf
+       set -e; \
        for i in            $(BYHAND_FILES); do                          \
          $(install_file)   $$i            ..                          ; \
          dpkg-distaddfile  -fdebian/files `basename $$i`     byhand - ; \