-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On Monday 25 June 2001 11:42 am, Anthony Towns wrote:
> Package: debian-policy
> Version: 3.5.5.0
>
> I think the most efficient way of handling usr/doc for woody will be
> to have everything reference /usr/share/doc, and require all packages
> to put their files in /usr/share/doc, and to make symlinks in
> /usr/doc. The latter is mainly for partial upgrades.
>
> To achieve this, we only need two changes: one, programs that access
> docs need to do so via /usr/share/doc, and two, we need to upgrade
> any existing bugs about usr/doc to serious (note that current policy
> already lists this as a "must", so this is a change in spirit not
> letter).
>
> The bugs this may affect are (greping for usr.doc or usr.share.doc in
> the subject):
>
> 34435 mpage mpage: `gzip -d <
> /usr/doc/omniorb/doc/omniORB2.dvi.gz|dvips 41441 sirc sirc:
> should not include /usr/doc/sirc/LICENSE.gz 45230 python-doc
> python-doc does not delete everything from /usr/doc 48608 purity
> error in file://localhost/usr/share/doc/purity/README.Debian 50053
> doc-linux- doc-linux-text has almost empty /usr/doc/doc-linux-text
> dire 50145 tin /usr/doc/tin is an empty directory
> 50158 speak-free should make symlink /usr/doc/speak-freely pointing
> to /usr/s 52629 xmame xmame: no symlink to /usr/doc
> 52996 console-to /usr/doc/console-tools-libs is still a directory
> 53520 doc-linux- doc-linux-text: non-english HOWTOs in
> /usr/share/doc/en-{txt 54860 linbot no link /usr/doc/linbot ->
> /usr/share/linbot 57367 tetex-base /usr/share/doc/texmf/mkhtml needs
> to be executable 57515 cvs-pcl `/usr/doc/cvs-pcl/html' not empty
> so not removed 58785 workbone workbone: lacks /usr/doc/workbone FHS
> symlink 59714 cruft cruft: Man page refers to old doc dir
> (/usr/doc/cruft should 60027 urlview
> moreinfo//usr/share/doc/urlview/html/.dhelp fails m5sum 62230
> doc-base doc-base: /usr/doc/doc-base/tmp/usr/doc/copyright, need I
> sa 62231 doc-base doc-base: /usr/doc/doc-base/tmp/usr/doc/copyright
> Need I sa 62352 general /usr/doc and /usr/share/doc confusion
> 62508 synaesthes synaesthesia: No /usr/doc/ -> /usr/share/doc link
> 63634 lurkftp lurkftp does not establish /usr/doc compatibility
> symlink 63885 logout-but logout-button: examples should be in
> /usr/share/doc 63928 dmalloc /usr/share/doc/dmalloc/html/.dhelp
> fails debsums 64055 ftape-doc ftape-doc uses /usr/doc instead of
> /usr/share/doc 64056 ftape-util ftape-util uses /usr/doc instead of
> /usr/share/doc 65205 fvwm fvwm: says
> /usr/share/doc/fvwm/README.upgrade, not README.De 66174 w3-el-e20
> spurious directory /usr/doc/w3-el
> 66860 dtaus dtaus: Docs not located in /usr/share/doc
> 67386 xemacs21 /usr/share/doc/sp/xml.htm wrong?
> 68216 swish++ Swish++ aborts while indexing /usr/doc
> 69021 apache apache: srm.conf defaults to /usr/doc, which gives
> permissio 69873 perlmenu perlmenu doesnt have a /usr/doc/perlmenu
> -> /usr/share/doc/p 71921 gxset gxset: new upstream version,
> URL, /usr/doc/gxset symlink 72310 qmail Empty /usr/doc/qmail
> 72493 emacsen-co Docs should be in /usr/share/doc
> 76095 cgilib /usr/doc/cgilib/examples/cgitest.c does not compile
> 78396 dpkg-dev Contains empty /usr/share/doc/dpkg-dev directory
> 79281 debian-key Typo in /usr/doc/debian-keyring/README.gz
> 79746 dpkg-cross [dpkg-cross]: dpkg-cross(1) (& others) refers to
> /usr/doc 79750 weblint [weblint]: documentation in /usr/doc
> 79925 svgalibg1- After removal symlink still present in /usr/doc
> 81015 imlib-base imlib-base: backwards /usr/share/doc link
> 81126 doc-base install-docs man page refers to /usr/doc instead of
> /usr/sha 83286 gnu-smallt ln -s ../../gnu-smalltalk/examples
> /usr/share/doc/gnu-smallt 84022 dftp dftp: problem with links
> in /usr/share/doc 85451 urlview patch/incorrect document id in
> /usr/share/doc-base/urlview 86567 exmh bug with /usr/doc ->
> /usr/share/doc transition 88991 urlredir /usr/doc/urlredir empty
> 91343 tetex-base Lots of empty dirs shipped on /usr/share/doc/texmf
> 91348 dpkg dpkg: desinformation regarding
> /usr/share/doc/dpkg/THANKS 91433 csound-doc Package csound-doc still
> has at least one file in /usr/doc 91439 dvidvi Package dvidvi
> still has at least one file in /usr/doc 91465 faqomatic Package
> faqomatic still has at least one file in /usr/doc 91469 gap4-tdat
> Package gap4-tdat still has at least one file in /usr/doc 91470
> gap4-gdat Package gap4-gdat still has at least one file in /usr/doc
> 91472 gbdk-dev Package gbdk-dev still has at least one file in
> /usr/doc 91497 htget Package htget still has at least one file
> in /usr/doc 91541 libcqcam-d Package libcqcam-dev still has at least
> one file in /usr/doc 91554 emacs20-el Package emacs20-el still has at
> least one file in /usr/doc 91558 libstdc++2 Package libstdc++2.8
> still has at least one file in /usr/doc 91586 mico-2.3.5 Package
> mico-2.3.0 still has at least one file in /usr/doc 91590 miscutils
> Package miscutils still has at least one file in /usr/doc 91592 nte
> Package nte still has at least one file in /usr/doc 91598
> ncurses3.4 Package ncurses3.4 still has at least one file in /usr/doc
> 91608 pccts patch/Package pccts still has at least one file in
> /usr/doc 91611 ncurses3.0 Package ncurses3.0 still has at least one
> file in /usr/doc 91616 picasm patch/Package picasm still has at
> least one file in /usr/doc 91627 propsel Package propsel still has
> at least one file in /usr/doc 91641 rscheme Package rscheme still
> has at least one file in /usr/doc 91643 qpage patch/Package
> qpage still has at least one file in /usr/doc 91644 sauce
> Package sauce still has at least one file in /usr/doc 91656 set6x86
> Package set6x86 still has at least one file in /usr/doc 91664
> splitdiges Package splitdigest still has at least one file in
> /usr/doc 91670 tendra-doc Package tendra-doc still has at least one
> file in /usr/doc 91675 tkps Package tkps still has at least one
> file in /usr/doc 91678 userv Package userv still has at least
> one file in /usr/doc 91682 tkinfo patch/Package tkinfo still has
> at least one file in /usr/doc 91685 vrwave Package vrwave still
> has at least one file in /usr/doc 91691 tkdesk Package tkdesk
> still has at least one file in /usr/doc 91694 x3270 Package
> x3270 still has at least one file in /usr/doc 91718 xchain
> patch/Package xchain still has at least one file in /usr/doc 91720
> xgdipc Package xgdipc still has at least one file in /usr/doc
> 91721 xzx Package xzx still has at least one file in /usr/doc
> 91722 xfstt Package xfstt still has at least one file in
> /usr/doc 91725 xserver-gg Package xserver-ggi still has at least one
> file in /usr/doc 91992 povray-doc garbage in
> /usr/share/doc/povray/povscn/level3/ionic5/b-snak 92925 jdk1.1
> jdk1.1: doesn't have /usr/doc -> /usr/share/doc symlink 93608
> smalleiffe /usr/share/doc/smalleiffel/html/compile.html should
> document 93853 mirror mirror disagrees with
> /usr/share/doc/mirror/mirror.html 94366 ntp-doc Breaks if /usr/doc
> is symlinked
> 95313 selfhtml selfhtml: wrong link in
> /usr/share/doc/selfhtml/html/tecbb.h 95626 libproplis libproplist0:
> Don't remove /usr/doc/libproplist0 on purge 95750 netscape-j
> netscape-ja-resource-477 overwrite `/usr/share/doc/netscape- 96495
> debsigs /usr/share/doc/debsigs/README.Debian is a template 96572
> dejagnu Empty html dir in /usr/share/doc/dejagnu
> 96903 csound-dev csound-dev: It tries to rewrite
> /usr/share/doc/csound/copyri 97400 memstat memstat's postinst says
> it is linking /usr/doc to /usr/share 97631 gedit gedit bad link
> in /usr/share/doc/gedit/
> 97891 python-gla Deletes documentation if /usr/doc is a symlink
> 98363 fvwm menudefs.hook contains reference to /usr/doc
> 99633 zebra missing /usr/doc/zebra/README.Debian
> 99703 cdparanoia Empty /usr/share/doc/cdparanoia directory
> 99789 dpkg WG: dselect/dpkg changes /usr/doc/HTML/ without a
> warning 99886 lintian no check for copyright refering to
> /usr/share/doc/common-lic 101392 plplot link to /usr/doc/plplot
> is missing
> 102097 libsdl1.2- Unnecessary files in
> /usr/share/doc/libsdl1.2-dev/examples/t 102184 ion manpage
> refers to /usr/doc instead of /usr/share/doc
>
> The packages this affects are (roughly):
>
> cqcam phototk
> dtmfdial picasm
> emacsen-common printop
> f77reorder propsel
> faqomatic qpage
> ftape-doc recite
> ftape-util rlinetd
> gap rocks-n-diamonds
> gap4-gdat rscheme
> gap4-tdat rscheme-modules
> gbdk rt
> gcc-m68k-linux sauce
> gerstensaft saytime
> glimpse sml-nj
> gs-aladdin-manual strn
> gs-aladdin-manual-de sysutils
> gsfonts-other tendra
> idled tendra-doc
> infocom tkdesk
> int-fiction tkinfo
> jlex tkps
> kernel-patch-2.0.37-raid userv
> lexmark7000linux vim-gtk
> lib-gnu.getopt-java vim-perl
> libcqcam-dev vim-python
> libggidemos vim-tcl
> libstdc++2.8 vim-tiny
> libterm-readline-perl-perl vrwave
> linpac vtprint
> logout-button witalian
> lzop wmheadlines
> ncompress x3270
> ncurses3.0 x3270-htmldoc
> ncurses3.0-altdev xchain
> ncurses3.4 xdemineur
> nte xgdipc
> onshore-timesheet-el xserver-ggi
> pccts
>
> A sample diff against policy would be:
>
> --- policy.sgml.orig Fri Jun 1 19:40:16 2001
> +++ policy.sgml Mon Jun 25 20:29:29 2001
> @@ -6481,14 +6481,7 @@
>
> <p>
> HTML documents for a package are stored in
> - <tt>/usr/share/doc/<var>package</var></tt> but
> should - be accessed via symlinks as
> - <tt>/usr/doc/<var>package</var></tt><footnote>
> - <p>
> - for backward compatibility; see <ref
> - id="usrdoc">
> - </p>
> - </footnote>
> + <tt>/usr/share/doc/<var>package</var></tt>
> and can be referred to as
> <example compact="compact">
> http://localhost/doc/<var>package</var>/<var>filename</var>
> @@ -7747,7 +7740,7 @@
> </example>
> To view the copyright file for a package you could use this
> command: <example>
> - dpkg --fsys-tarfile <var>filename</var>.deb | tar xof
> usr/doc/<var>\*</var>co pyright | less
> + dpkg --fsys-tarfile <var>filename</var>.deb | tar xof
> usr/share/doc/<var>\*</ var>copyright | less
> </example>
> </p>
> </sect>
>
>
> Seconds? Comments?
>
> Cheers,
> aj
Be aware that your list is somewhat out of date.
http://qa.debian.org/fhs/html
has a more up to date list.
I second this proposal
- --
Stephen Stafford
GPG public key on request
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: For info see http://www.gnupg.org
iD8DBQE7N3ZYFwmY7Xa4pD0RAqjnAKCUYWu7dXxCYhXrbJhblgN/4C7EtACfVS4J
vwO86UssrL+DC4+FIJRBEPU=
=OpPy
-----END PGP SIGNATURE-----
