[debhelper-devel] Bug#886108: Bug#886108: debhelper: dh_installdocs -A at compat=11 installs docs in wrong place

[Axel Beckert]

Hi Tomasz,

Tomasz Buchert wrote:
> I wanted to switch nghttp2 to compat=11, but this causes
> binaries-have-file-conflict:
> 
> W: nghttp2 source: binaries-have-file-conflict libnghttp2-dev libnghttp2-doc
> usr/share/doc/libnghttp2-dev/AUTHORS
> W: nghttp2 source: binaries-have-file-conflict libnghttp2-dev libnghttp2-doc
> usr/share/doc/libnghttp2-dev/README.rst.gz

The file conflicts comes indeed from "dh_installdocs -A README.rst
AUTHORS".

> The conflicting files are installed in
> /usr/share/doc/libnghttp2-dev, although the package is
> libnghttp2-doc.

But that sounds correct. From debhelper(7), differences between v10
and v11:

   The dh_installdocs and dh_installexamples tools will now attempt to
   guess the "main package" for a given documentation package (e.g.
   pkg-doc will have pkg as main package if the latter exists). If a
   main package is found, most of the documentation will be installed
   into /usr/share/doc/main-pkg by default as recommended by Debian
   policy §12.3 since version 3.9.7. Notable exceptions include the
   copyright file and changelog files.

And policy §12.3
(https://www.debian.org/doc/debian-policy/#additional-documentation)
says:

  Additional documentation included in the package should be installed
  under /usr/share/doc/package. If the documentation is packaged
  separately, as package-doc for example, it may be installed
  under either that path or into the documentation directory for the
  separate documentation package (/usr/share/doc/package-doc in this
  example). However, installing the documentation into the
  documentation directory of the main package is preferred since it is
  independent of the packaging method and will be easier for users to
  find.

Please note the last sentence of that paragraph.

> This can be worked around by using --doc-main-package,

No, that's probably the wrong approach.

> but I think there is something wrong happening here.

Yes, I think the ideas behind -A and installing documentation by
default into the main package's doc directory are conflicting with
each other.

So I wonder if "dh_installdocs -A" should make an exception from
installing the documentation into /usr/share/doc/main-pkg/ like it is
already happening for changelog and copyright files.

		Regards, Axel
-- 
 ,''`.  |  Axel Beckert <abe at debian.org>, https://people.debian.org/~abe/
: :' :  |  Debian Developer, ftp.ch.debian.org Admin
`. `'   |  4096R: 2517 B724 C5F6 CA99 5329  6E61 2FF9 CD59 6126 16B5
  `-    |  1024D: F067 EA27 26B9 C3FC 1486  202E C09E 1D89 9593 0EDE