From e369912eff1a2ff024668531cbd127ed48e61fcf Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Sat, 7 Jan 2012 08:50:11 -0800 Subject: [PATCH] Some further wording tweaks to additional documentation Weaken the documentation location to "should" to match previous behavior. Change the example of text documentation from TODOs to FAQs. Clarify that documentation should be installed elsewhere if it is used or read by programs, rather than using the ambiguous term "referenced." --- policy.sgml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/policy.sgml b/policy.sgml index 7afd0fa..404dc73 100644 --- a/policy.sgml +++ b/policy.sgml @@ -10669,10 +10669,10 @@ END-INFO-DIR-ENTRY Any additional documentation that comes with the package may be installed at the discretion of the package maintainer. It is often a good idea to include text information files - (READMEs, TODOs, and so forth) that - come with the source package in the binary package. However, - you don't need to install the instructions for building and - installing the package, of course! + (READMEs, FAQs, and so forth) that come with the + source package in the binary package. However, you don't need + to install the instructions for building and installing the + package, of course!

@@ -10699,7 +10699,7 @@ END-INFO-DIR-ENTRY

- Additional documentation included in the package must be + 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 @@ -10727,9 +10727,9 @@ END-INFO-DIR-ENTRY The system administrator should be able to delete files in /usr/share/doc/ without causing any programs to break. - . Any files that are referenced by programs but are - also useful as stand alone documentation should be installed - elsewhere, normally + . Any files that are used or read by programs but + are also useful as stand alone documentation should be installed + elsewhere, such as under /usr/share/package/, and then included via symbolic links in /usr/share/doc/package. -- 2.39.2