[Python-apps-team] Bug#905193: alot-doc: unhandled symlink to directory conversion: /usr/share/doc/alot/html -> ../alot-doc/html

[Andreas Beckmann]

Package: alot-doc
Version: 0.7-1
Severity: serious
User: debian-qa at lists.debian.org
Usertags: piuparts

Hi,

an upgrade test with piuparts revealed that your package installs files
over existing symlinks and possibly overwrites files owned by other
packages. This usually means an old version of the package shipped a
symlink but that was later replaced by a real (and non-empty)
directory. This kind of overwriting another package's files cannot be
detected by dpkg.

This was observed on the following upgrade paths:

  stretch -> buster

For /usr/share/doc/PACKAGE this may not be problematic as long as both
packages are installed, ship byte-for-byte identical files and are
upgraded in lockstep. But once one of the involved packages gets
removed, the other one will lose its documentation files, too,
including the copyright file, which is a violation of Policy 12.5:
https://www.debian.org/doc/debian-policy/#copyright-information

For other overwritten locations anything interesting may happen.

Note that dpkg intentionally does not replace directories with symlinks
and vice versa, you need the maintainer scripts to do this.
See in particular the end of point 4 in
https://www.debian.org/doc/debian-policy/#details-of-unpack-phase-of-installation-or-upgrade

It is recommended to use the dpkg-maintscript-helper commands
'dir_to_symlink' and 'symlink_to_dir' (available since dpkg 1.17.14)
to perform the conversion, ideally using d/$PACKAGE.maintscript.
Do not forget to add 'Pre-Depends: ${misc:Pre-Depends}' in d/control.
See dpkg-maintscript-helper(1) and dh_installdeb(1) for details.


>From the attached log (scroll to the bottom...):

0m29.5s INFO: dirname part contains a symlink:
  /usr/share/doc/alot/html/_sources (alot-doc) != /usr/share/doc/alot-doc/html/_sources (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/_sources/api (alot-doc) != /usr/share/doc/alot-doc/html/_sources/api (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/_sources/api/commands.rst.txt (alot-doc) != /usr/share/doc/alot-doc/html/_sources/api/commands.rst.txt (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/_sources/api/contributing.rst.txt (alot-doc) != /usr/share/doc/alot-doc/html/_sources/api/contributing.rst.txt (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/_sources/api/crypto.rst.txt (alot-doc) != /usr/share/doc/alot-doc/html/_sources/api/crypto.rst.txt (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/_sources/api/database.rst.txt (alot-doc) != /usr/share/doc/alot-doc/html/_sources/api/database.rst.txt (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/_sources/api/index.rst.txt (alot-doc) != /usr/share/doc/alot-doc/html/_sources/api/index.rst.txt (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
[...]
  /usr/share/doc/alot/html/usage/modes/search.html (alot-doc) != /usr/share/doc/alot-doc/html/usage/modes/search.html (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/usage/modes/taglist.html (alot-doc) != /usr/share/doc/alot-doc/html/usage/modes/taglist.html (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/usage/modes/thread.html (alot-doc) != /usr/share/doc/alot-doc/html/usage/modes/thread.html (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/usage/signals.html (alot-doc) != /usr/share/doc/alot-doc/html/usage/signals.html (?)
    /usr/share/doc/alot/html -> ../alot-doc/html
  /usr/share/doc/alot/html/usage/synopsis.html (alot-doc) != /usr/share/doc/alot-doc/html/usage/synopsis.html (?)
    /usr/share/doc/alot/html -> ../alot-doc/html


This is probably caused by a behavioral change of dh_installdocs
in debhelper compat level 11.


cheers,

Andreas
-------------- next part --------------
A non-text attachment was scrubbed...
Name: alot-doc_0.7-1.log.gz
Type: application/gzip
Size: 20265 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/python-apps-team/attachments/20180801/d4826522/attachment-0001.gz>