From 0e58a7e67c225766da50544e54459e39172d18ee Mon Sep 17 00:00:00 2001 From: Ben Finney Date: Fri, 6 Jan 2012 08:27:28 -0800 Subject: [PATCH] Recommend documentation go in /usr/share/doc/ Recommend that documentation be installed into /usr/share/doc/ even if it's packaged separately. Closes: #106073 --- policy.sgml | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/policy.sgml b/policy.sgml index a8afd41..d8e6efe 100644 --- a/policy.sgml +++ b/policy.sgml @@ -10662,16 +10662,17 @@ END-INFO-DIR-ENTRY

- + Additional documentation

Any additional documentation that comes with the package may be installed at the discretion of the package maintainer. - Plain 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. +

+ +

+ Plain text documentation should be compressed with gzip + -9 unless it is small.

@@ -10681,6 +10682,25 @@ END-INFO-DIR-ENTRY take up disk space on the machines of users who do not need or want it installed.

+

+ Additional documentation for package, whether the + documentation is packaged separately or not, should be + installed to the directory + /usr/share/doc/package or its + subdirectories. + Rationale: Once installed, the separation of the + documentation packaging should be invisible to the user, + and the documentation should be found in the expected + location for the main binary package. + +

+ +

+ Any separate package providing documentation must still + install files as specified in the rest of this policy; for + example, and . +

+

It is often a good idea to put text information files (READMEs, changelogs, and so forth) that come with @@ -10742,16 +10762,16 @@ END-INFO-DIR-ENTRY via HTML.

- If your package comes with extensive documentation in a + If the package comes with extensive documentation in a markup format that can be converted to various other formats you should if possible ship HTML versions in a binary - package, in the directory - /usr/share/doc/appropriate-package or - its subdirectories. - The rationale: The important thing here is that HTML - docs should be available in some package, not - necessarily in the main binary package. + package. + Rationale: The important thing here is that HTML + documentation should be available from some + binary package. + The documentation must be installed as specified in + .

-- 2.39.2