Move documents under /usr/share/doc

Signed-off-by: Osamu Aoki <osamu@debian.org>
This commit is contained in:
Osamu Aoki 2023-12-18 21:07:23 +09:00
parent b3d596abb7
commit 7e01b4b165
18 changed files with 39 additions and 127 deletions

View file

@ -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`

View file

@ -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

View file

@ -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 "<hr>"
echo "<p>All files are encoded in <b>UTF-8</b>.</p>"
echo "<p>If your favorite language is not found in this list, please install the corresponding <tt>debian-reference-*</tt> package.</p>"
echo "<p>Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from <a href=\"$DOC_ROOT\">$DOC_ROOT</a>. See <a href=\"$README\">README<a> for more help and information.</p>"
echo "<p>Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from <a href=\"$DR_DOC_ROOT/docs\">$DR_DOC_ROOT/docs</a>. See <a href=\"$README\">README<a> for more help and information.</p>"
echo "</body>"
echo "</html>"
}
@ -90,17 +90,18 @@ echoindex0 () {
echo "</dl>"
echo "<hr>"
echo "<p>All files are encoded in <b>UTF-8</b>.</p>"
echo "<p>Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from <a href=\"$DOC_ROOT\">$DOC_ROOT</a>. See <a href=\"$README\">README<a> for more help and information.</p>"
echo "<p>Some browsers may not be setup to read compressed plain text. Use appropriate file viewer system to read them directly from <a href=\"$DR_DOC_ROOT/docs\">$DR_DOC_ROOT/docs</a>. See <a href=\"$README\">README<a> for more help and information.</p>"
echo "</body>"
echo "</html>"
}
# 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.

View file

@ -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

View file

@ -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

2
debian/all.links-in vendored
View file

@ -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

View file

@ -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

View file

@ -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
;;
*)

View file

@ -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
;;
*)

4
debian/control vendored
View file

@ -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.

View file

@ -1 +0,0 @@
usr/share/debian-reference

View file

@ -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

View file

@ -1 +0,0 @@
usr/share/debian-reference/ usr/share/doc/debian-reference-common/docs

View file

@ -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

View file

@ -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

View file

@ -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

14
debian/rules vendored
View file

@ -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

View file

@ -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