From 7e01b4b1657a1cd8cf3289ef6ac7894e9918b6ad Mon Sep 17 00:00:00 2001 From: Osamu Aoki Date: Mon, 18 Dec 2023 21:07:23 +0900 Subject: [PATCH] Move documents under /usr/share/doc Signed-off-by: Osamu Aoki --- README.md | 2 +- bin/debian-reference | 8 +++--- bin/mkindexhtml | 15 +++++------ debian/all.doc-base-in | 8 +++--- debian/all.install-in | 6 ++--- debian/all.links-in | 2 +- debian/all.lintian-overrides-in | 17 ------------- debian/all.postinst-in | 6 +---- debian/all.postrm-in | 6 +---- debian/control | 4 +-- debian/debian-reference-common.dirs | 1 - debian/debian-reference-common.install | 6 ++--- debian/debian-reference-common.links | 1 - debian/debian-reference-common.postinst | 33 ------------------------- debian/debian-reference-common.postrm | 27 -------------------- debian/debian-reference.links | 2 +- debian/rules | 14 +++++------ debian/tests/check-script | 8 +++--- 18 files changed, 39 insertions(+), 127 deletions(-) delete mode 100644 debian/all.lintian-overrides-in delete mode 100644 debian/debian-reference-common.dirs delete mode 100644 debian/debian-reference-common.links delete mode 100644 debian/debian-reference-common.postinst delete mode 100644 debian/debian-reference-common.postrm diff --git a/README.md b/README.md index fc687958..3eba950a 100644 --- a/README.md +++ b/README.md @@ -679,7 +679,7 @@ These are generated from the latest released packages by the `cron` script run on the master www.debian.org server and they are mirrored to all the www.debian.org servers. - * https://anonscm.debian.org/git/debwww/cron.git (Maybe moving to salsa soon) + * https://salsa.debian.org/webmaster-team/cron * `parts/1ftpfiles` * `parts/7doc` diff --git a/bin/debian-reference b/bin/debian-reference index d08d2edf..e20c11f1 100755 --- a/bin/debian-reference +++ b/bin/debian-reference @@ -1,9 +1,9 @@ #!/bin/sh # POSIX compliant script to search browser set -e # stop at first error -#set -x # debug +#set -x # debug -BDOCUMENTSTEM="/usr/share/debian-reference" -if [ -r $BDOCUMENTSTEM/index.html ]; then - /usr/bin/sensible-browser $BDOCUMENTSTEM/index.html +DR_DOC_ROOT="/usr/share/doc/debian-reference" +if [ -d $DR_DOC_ROOT ] && [ -d $DR_DOC_ROOT/docs ] && [ -r $DR_DOC_ROOT/docs/index.html ]; then + /usr/bin/sensible-browser $DR_DOC_ROOT/docs/index.html fi diff --git a/bin/mkindexhtml b/bin/mkindexhtml index 33e257a9..3fbc7bb0 100755 --- a/bin/mkindexhtml +++ b/bin/mkindexhtml @@ -3,7 +3,7 @@ # vim:set sw=2 et sts=2: TITLE="Debian Reference (version 2)" PACKAGE="debian-reference" # Yes this has been changed -DOC_ROOT=${DOC_ROOT:-/usr/share/debian-reference} +DR_DOC_ROOT=${DR_DOC_ROOT:-/usr/share/doc/debian-reference} README="/usr/share/doc/debian-reference-common/README" # Echo Language name @@ -65,7 +65,7 @@ echoindex () { echo "
" echo "

All files are encoded in UTF-8.

" echo "

If your favorite language is not found in this list, please install the corresponding debian-reference-* package.

" - echo "

Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from $DOC_ROOT. See README for more help and information.

" + echo "

Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from $DR_DOC_ROOT/docs. See README for more help and information.

" echo "" echo "" } @@ -90,17 +90,18 @@ echoindex0 () { echo "" echo "
" echo "

All files are encoded in UTF-8.

" - echo "

Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from $DOC_ROOT. See README for more help and information.

" + echo "

Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from $DR_DOC_ROOT/docs. See README for more help and information.

" echo "" echo "" } -# Always remove index page and move to the $DOC_ROOT directory -if [ -d "$DOC_ROOT" ]; then - cd "$DOC_ROOT" +# Skip if $DR_DOC_ROOT directory or $DR_DOC_ROOT/docs are missing +# Always remove index page and move to the $DR_DOC_ROOT directory +if [ -d "$DR_DOC_ROOT" ] && [ -d "$DR_DOC_ROOT/docs" ]; then + cd "$DR_DOC_ROOT/docs" # index.html can be symlink or file rm -f index.html else - # You may have removed the $DOC_ROOT directory + # You may have removed the $DR_DOC_ROOT directory exit 0 fi # Always sort language with English as top. diff --git a/debian/all.doc-base-in b/debian/all.doc-base-in index 3857a814..87302fe4 100644 --- a/debian/all.doc-base-in +++ b/debian/all.doc-base-in @@ -6,12 +6,12 @@ Abstract: This Debian Reference covers many aspects of system Section: Debian Format: text -Files: /usr/share/doc/debian-reference-@@/docs/debian-reference.@@.txt.gz +Files: /usr/share/doc/debian-reference-common/docs/debian-reference.@@.txt.gz Format: PDF -Files: /usr/share/doc/debian-reference-@@/docs/debian-reference.@@.pdf +Files: /usr/share/doc/debian-reference-common/docs/debian-reference.@@.pdf Format: HTML -Index: /usr/share/doc/debian-reference-@@/docs/index.@@.html -Files: /usr/share/doc/debian-reference-@@/docs/*.@@.html +Index: /usr/share/doc/debian-reference-common/docs/index.@@.html +Files: /usr/share/doc/debian-reference-common/docs/*.@@.html diff --git a/debian/all.install-in b/debian/all.install-in index aa4053de..11f0696a 100644 --- a/debian/all.install-in +++ b/debian/all.install-in @@ -1,3 +1,3 @@ -build/debian-reference.@@.txt.gz usr/share/debian-reference/ -build/debian-reference.@@.pdf usr/share/debian-reference/ -build/*.@@.html usr/share/debian-reference/ +build/debian-reference.@@.txt.gz usr/share/doc/debian-reference-common/docs +build/debian-reference.@@.pdf usr/share/doc/debian-reference-common/docs +build/*.@@.html usr/share/doc/debian-reference-common/docs diff --git a/debian/all.links-in b/debian/all.links-in index 99eca5b4..c92796f4 100644 --- a/debian/all.links-in +++ b/debian/all.links-in @@ -1,2 +1,2 @@ +usr/share/doc/debian-reference-common/docs usr/share/doc/debian-reference-@@/docs usr/share/doc/debian-reference-common/README.md.gz usr/share/doc/debian-reference-@@/README.md.gz -usr/share/debian-reference/ usr/share/doc/debian-reference-@@/docs diff --git a/debian/all.lintian-overrides-in b/debian/all.lintian-overrides-in deleted file mode 100644 index c19f631a..00000000 --- a/debian/all.lintian-overrides-in +++ /dev/null @@ -1,17 +0,0 @@ -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch01.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch02.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch03.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch04.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch05.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch06.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch07.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch08.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch09.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch10.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch11.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/ch12.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/index.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/pr01.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/apa.@@.html -debian-reference-@@: package-contains-documentation-outside-usr-share-doc usr/share/debian-reference/debian-reference.@@.pdf - diff --git a/debian/all.postinst-in b/debian/all.postinst-in index d029344f..6ba5704a 100644 --- a/debian/all.postinst-in +++ b/debian/all.postinst-in @@ -9,14 +9,10 @@ case "$1" in configure|abort-upgrade|abort-remove|abort-deconfigure) # always try keeping the best index if [ -x /usr/share/debian-reference-common/mkindexhtml ] ; then - HTMLROOT=/usr/share/debian-reference - export HTMLROOT /usr/share/debian-reference-common/mkindexhtml else - rm -f /usr/share/debian-reference/index.html + rm -f /usr/share/doc/debian-reference-common/docs/index.html || true fi - # remove directory if empty (no --ignore-fail-on-non-empty) - rmdir /usr/share/debian-reference 2>/dev/null || true ;; *) diff --git a/debian/all.postrm-in b/debian/all.postrm-in index c83970a7..cd6555de 100644 --- a/debian/all.postrm-in +++ b/debian/all.postrm-in @@ -9,14 +9,10 @@ case "$1" in remove|purge|upgrade|failed-upgrade|abort-install|abort-upgrade) # always try keeping the best index if [ -x /usr/share/debian-reference-common/mkindexhtml ] ; then - HTMLROOT=/usr/share/debian-reference - export HTMLROOT /usr/share/debian-reference-common/mkindexhtml else - rm -f /usr/share/debian-reference/index.html + rm -f /usr/share/doc/debian-reference-common/docs/index.html || true fi - # remove directory if empty (no --ignore-fail-on-non-empty) - rmdir /usr/share/debian-reference 2>/dev/null || true ;; *) diff --git a/debian/control b/debian/control index d73a1ba6..17cac48d 100644 --- a/debian/control +++ b/debian/control @@ -27,7 +27,7 @@ Build-Depends-Indep: dblatex, texlive-xetex, w3m, xsltproc -Standards-Version: 4.6.0 +Standards-Version: 4.6.2 Vcs-Git: https://salsa.debian.org/debian/debian-reference.git -b latest Vcs-Browser: https://salsa.debian.org/debian/debian-reference Homepage: https://www.debian.org/doc/user-manuals#quick-reference @@ -157,7 +157,7 @@ Package: debian-reference-pt-br Architecture: all Depends: debian-reference-common (>= 2.51), ${misc:Depends} Suggests: debian-reference-en, doc-base -Description: Debian system administration guide, Portuguese translation +Description: Debian system administration guide, Portuguese (Brazil) translation This Debian Reference is intended to provide a broad overview of the Debian system as a post-installation user's guide. It covers many aspects of system administration through shell-command examples for non-developers. diff --git a/debian/debian-reference-common.dirs b/debian/debian-reference-common.dirs deleted file mode 100644 index 45890367..00000000 --- a/debian/debian-reference-common.dirs +++ /dev/null @@ -1 +0,0 @@ -usr/share/debian-reference diff --git a/debian/debian-reference-common.install b/debian/debian-reference-common.install index 6a150622..ff8e67e2 100644 --- a/debian/debian-reference-common.install +++ b/debian/debian-reference-common.install @@ -1,7 +1,7 @@ bin/debian-reference usr/bin bin/mkindexhtml usr/share/debian-reference-common -build/.htaccess usr/share/debian-reference -build/debian-reference.css usr/share/debian-reference -build/images/* usr/share/debian-reference/images +build/.htaccess usr/share/doc/debian-reference-common/docs +build/debian-reference.css usr/share/doc/debian-reference-common/docs +build/images/* usr/share/doc/debian-reference-common/docs/images debian/debian-reference-common.desktop usr/share/applications debian/debian-reference.png usr/share/pixmaps diff --git a/debian/debian-reference-common.links b/debian/debian-reference-common.links deleted file mode 100644 index 8c11188a..00000000 --- a/debian/debian-reference-common.links +++ /dev/null @@ -1 +0,0 @@ -usr/share/debian-reference/ usr/share/doc/debian-reference-common/docs diff --git a/debian/debian-reference-common.postinst b/debian/debian-reference-common.postinst deleted file mode 100644 index d029344f..00000000 --- a/debian/debian-reference-common.postinst +++ /dev/null @@ -1,33 +0,0 @@ -#! /bin/sh -# postinst script for debian-reference-* -# -# see: dh_installdeb(1) - -set -e - -case "$1" in - configure|abort-upgrade|abort-remove|abort-deconfigure) - # always try keeping the best index - if [ -x /usr/share/debian-reference-common/mkindexhtml ] ; then - HTMLROOT=/usr/share/debian-reference - export HTMLROOT - /usr/share/debian-reference-common/mkindexhtml - else - rm -f /usr/share/debian-reference/index.html - fi - # remove directory if empty (no --ignore-fail-on-non-empty) - rmdir /usr/share/debian-reference 2>/dev/null || true - ;; - - *) - : # do nothing - ;; -esac - -# dh_installdeb will replace this with shell code automatically -# generated by other debhelper scripts. - -#DEBHELPER# - -exit 0 - diff --git a/debian/debian-reference-common.postrm b/debian/debian-reference-common.postrm deleted file mode 100644 index 34527b7f..00000000 --- a/debian/debian-reference-common.postrm +++ /dev/null @@ -1,27 +0,0 @@ -#! /bin/sh -# postrm script for debian-reference-* -# -# see: dh_installdeb(1) - -set -e - -case "$1" in - remove|purge|upgrade|failed-upgrade|abort-install|abort-upgrade) - # always remove index - rm -f /usr/share/debian-reference/index.html - # remove directory if empty (no --ignore-fail-on-non-empty) - rmdir /usr/share/debian-reference 2>/dev/null || true - ;; - - *) - : # do nothing - ;; -esac - -# dh_installdeb will replace this with shell code automatically -# generated by other debhelper scripts. - -#DEBHELPER# - -exit 0 - diff --git a/debian/debian-reference.links b/debian/debian-reference.links index 60f199f6..4f2d0a31 100644 --- a/debian/debian-reference.links +++ b/debian/debian-reference.links @@ -1,2 +1,2 @@ -usr/share/debian-reference/ usr/share/doc/debian-reference/docs +usr/share/doc/debian-reference-common/docs usr/share/doc/debian-reference/docs usr/share/doc/debian-reference-common/README.md.gz usr/share/doc/debian-reference/README.md.gz diff --git a/debian/rules b/debian/rules index aa4f8d3d..dc55c7a7 100755 --- a/debian/rules +++ b/debian/rules @@ -31,10 +31,9 @@ NOPDF := override_dh_auto_build: # Generate files for debhelper in debian/ cd $(CURDIR)/debian/ ; \ - cp all.preinst-in $(MANUAL)-common.preinst ; \ cp all.postinst-in $(MANUAL)-common.postinst ; \ + cp all.postrm-in $(MANUAL)-common.postrm ; \ for XX in $(LANGALL) ; do \ - cp all.preinst-in $(MANUAL)-$${XX}.preinst ; \ cp all.postinst-in $(MANUAL)-$${XX}.postinst ; \ cp all.postrm-in $(MANUAL)-$${XX}.postrm ; \ case $$XX in \ @@ -53,10 +52,9 @@ override_dh_auto_build: zh-cn) LANGX="Chinese (Simplified)" ;; \ *) LANGX="$$x" ;; \ esac ; \ - sed -e "s/@@/$$XX/g" < all.links-in >$(MANUAL)-$${XX}.links ; \ sed -e "s/@@/$$XX/g" < all.install-in >$(MANUAL)-$${XX}.install ; \ + sed -e "s/@@/$$XX/g" < all.links-in >$(MANUAL)-$${XX}.links ; \ sed -e "s/@@/$$XX/g" -e "s/@LANG@/$$LANGX/g" < all.doc-base-in >$(MANUAL)-$${XX}.doc-base ; \ - sed -e "s/@@/$$XX/g" < all.lintian-overrides-in >$(MANUAL)-$${XX}.lintian-overrides ; \ done dh_auto_build $(BUILDOPT) -- \ "LANGALL=$(LANGALL)" \ @@ -78,10 +76,10 @@ endif override_dh_auto_clean: # Clean files for debhelper in debian/ - -rm -f $(MANUAL)-common.preinst $(MANUAL)-common.postinst - -rm -f $(addsuffix .postinst, $(addprefix debian/$(MANUAL)-, $(LANGALL))) - -rm -f $(addsuffix .postrm, $(addprefix debian/$(MANUAL)-, $(LANGALL))) + -rm -f $(MANUAL)-common.postinst $(MANUAL)-common.postrm + -rm -f $(addsuffix .postinst, $(addprefix debian/$(MANUAL)-, $(LANGALL) common)) + -rm -f $(addsuffix .postrm, $(addprefix debian/$(MANUAL)-, $(LANGALL) common)) -rm -f $(addsuffix .links, $(addprefix debian/$(MANUAL)-, $(LANGALL))) - -rm -f $(addsuffix .doc-base, $(addprefix debian/$(MANUAL)-, $(LANGALL))) -rm -f $(addsuffix .install, $(addprefix debian/$(MANUAL)-, $(LANGALL))) + -rm -f $(addsuffix .doc-base, $(addprefix debian/$(MANUAL)-, $(LANGALL))) $(MAKE) "LANGALL=$(LANGALL)" "LANGPO=$(LANGPO)" clean diff --git a/debian/tests/check-script b/debian/tests/check-script index 090d49f7..fe9acc91 100755 --- a/debian/tests/check-script +++ b/debian/tests/check-script @@ -2,12 +2,12 @@ # check syntax of browser start script /bin/dash -n /usr/bin/debian-reference # check index.htmlnnd idex.en.html -test -r /usr/share/debian-reference/index.html -test -r /usr/share/debian-reference/index.en.html +test -r /usr/share/doc/debian-reference-common/docs/index.html +test -r /usr/share/doc/debian-reference-common/docs/index.en.html # css -test -r /usr/share/debian-reference/images/home.png +test -r /usr/share/doc/debian-reference-common/docs/images/home.png # pdf -test -r /usr/share/debian-reference/debian-reference.en.pdf +test -r /usr/share/doc/debian-reference-common/docs/debian-reference.en.pdf # desktop test -r /usr/share/applications/debian-reference-common.desktop # manpage