Your message dated Thu, 22 Sep 2016 23:18:43 +0000
with message-id <20160922231843.gc10...@athena.silentflame.com>
and subject line Re: dh_installdocs: look for README.foo
has caused the Debian Bug report #838538,
regarding dh_installdocs: look for README.foo
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact ow...@bugs.debian.org
immediately.)
--
838538: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=838538
Debian Bug Tracking System
Contact ow...@bugs.debian.org with problems
--- Begin Message ---
Package: debhelper
Version: 10
Severity: wishlist
Dear maintainers,
Lots of upstreams include a readme called 'README.md', 'README.rst',
'README.markdown' etc., rather than just 'README'. It would be nice if
dh_installdocs would install these automatically, as it currently
installs plain 'README'.
Markdown and reStructuredText are designed to be readable without
knowledge of the markup language, so these files are equally suitable
for installation to /usr/share/doc/*/.
Thanks.
-- System Information:
Debian Release: stretch/sid
APT prefers testing
APT policy: (900, 'testing')
Architecture: i386 (i686)
Kernel: Linux 4.6.0-1-686-pae (SMP w/2 CPU cores)
Locale: LANG=en_GB.utf8, LC_CTYPE=en_GB.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
Versions of packages debhelper depends on:
ii autotools-dev 20160430.1
ii binutils 2.26.1-1
ii dh-autoreconf 12
ii dh-strip-nondeterminism 0.023-2
ii dpkg 1.18.10
ii dpkg-dev 1.18.10
ii file 1:5.28-4
ii libdpkg-perl 1.18.10
ii man-db 2.7.5-1
ii perl 5.22.2-5
ii po-debconf 1.0.19
debhelper recommends no packages.
Versions of packages debhelper suggests:
pn dh-make <none>
-- no debconf information
--
Sean Whitton
--- End Message ---
--- Begin Message ---
Dear Niels,
On Thu, Sep 22, 2016 at 05:19:00AM +0000, Niels Thykier wrote:
> I am a bit confused that your report suggests that dh_installdocs
> install "README" by default. I cannot find any evidence in the
> dh_installdocs(1) manpage nor in the code that it does this. The best I
> can find is that the "debian/package.docs" example includes the README file.
My mistake. Someone else told me that dh_installdocs installs README
but not README.md, and I didn't verify it for myself before reporting.
> This proposal is based on the assumption that the READMEs are
> generally of interest. However, as I recall, the upstream READMEs
> were often not always relevant (e.g. focused on build/install
> instructions), which is why they were previously not installed by
> default.
I agree. They often need to be patched to remove installation and build
instructions. Having to explicitly add them to debian/docs is a way of
ensuring that the packager has confirmed the README is useful, and/or
patched it.
Please accept my apologies for over-eagerly reporting this bug.
--
Sean Whitton
--- End Message ---
