[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#910783: Remove doc-base recommendation



Hello,

On Sun 14 Jul 2019 at 10:22AM +02, Ansgar wrote:

> How should we continue with this issue?

Thank you for following up.

I still do not see any positive reason for deleting documentation which
might be helpful to someone, especially when discussion in the bug has
indicated that people are doing work which might come to depend on
doc-base.

However, it is clear that we do not think a lack of doc-base
registration is a bug of severity greater than wishlist, which is what
the current Policy wording implies.

Therefore I would like to propose the following change:

diff --git a/policy/ch-customized-programs.rst b/policy/ch-customized-programs.rst
index 529aa66..dbba4fc 100644
--- a/policy/ch-customized-programs.rst
+++ b/policy/ch-customized-programs.rst
@@ -151,9 +151,8 @@ web servers and web applications in the Debian system.
 
    Web Applications should try to avoid storing files in the Web
    Document Root. Instead they should use the /usr/share/doc/package
-   directory for documents and register the Web Application via the
-   doc-base package. If access to the web document root is unavoidable
-   then use
+   directory for documents. If access to the web document root is
+   unavoidable then use
 
    ::
 
diff --git a/policy/ch-opersys.rst b/policy/ch-opersys.rst
index 6e0c020..fa1428f 100644
--- a/policy/ch-opersys.rst
+++ b/policy/ch-opersys.rst
@@ -976,11 +976,11 @@ Here is an example of a wrapper script for this purpose:
 Registering Documents using doc-base
 ------------------------------------
 
-The doc-base package implements a flexible mechanism for handling and
-presenting documentation. The recommended practice is for every Debian
-package that provides online documentation (other than just manual
-pages) to register these documents with doc-base by installing a
-doc-base control file in ``/usr/share/doc-base/``.
+The doc-base package implements a mechanism for handling and
+presenting documentation. Debian packages that provides online
+documentation (other than just manual pages) may register these
+documents with doc-base by installing a doc-base control file in
+``/usr/share/doc-base/``.
 
 Please refer to the documentation that comes with the doc-base package
 for information and details.

-- 
Sean Whitton

Attachment: signature.asc
Description: PGP signature


Reply to: