Bug#367697: clarify 12.3 Additional documentation
Package: debian-policy
Version: 3.7.2.0
Severity: wishlist
I would like to see some clarifications for section 12.3 "Additional
documentation", in particular this:
Any additional documentation that comes with the package may be installed
at the discretion of the package maintainer. Text documentation should be
installed in the directory /usr/share/doc/package, where package is the
name of the package, and compressed with gzip -9 unless it is small.
I was wondering what "text documentation" means. Does it mean plain-text
formatted or anything that contains text (e.g., HTML)? I also notice that
nothing here tells where to put non-text documentation, such as images or
interactive tutorials. (I know it's clear, but the wording might be
unnecessarily specific.) Perhaps it would clearer this way:
Any additional documentation that comes with the package may be installed
at the discretion of the package maintainer. Documentation files should be
installed in the directory /usr/share/doc/package, where package is the
name of the package. Plain-text files should be compressed with gzip -9
unless they are small.
Or perhaps:
Any additional documentation that comes with the package may be installed
at the discretion of the package maintainer. Documentation files should be
installed in the directory /usr/share/doc/package, where package is the
name of the package. All such files should be compressed with gzip -9
unless they are small.
Depending on the actual intent.
Reply to: