[Reproducible-commits] [debhelper] 43/61: dh_installdocs: Document a caveat of using --link-doc

[Mattia Rizzolo]

This is an automated email from the git hooks/post-receive script.

mapreri-guest pushed a commit to branch pu/reproducible_builds
in repository debhelper.

commit fe39ddd333aa82ac75c5d470dd43896f852a89e5
Author: Niels Thykier <niels at thykier.net>
Date:   Thu Jan 8 21:50:17 2015 +0100

    dh_installdocs: Document a caveat of using --link-doc
    
    Warn about the possible need for a "dir to symlink" (or "symlink to
    dir") migration when using (or stopping the use of) --link-doc.  Refer
    people to dh_installdeb's maintscript feature for implementing said
    migration.
    
    Signed-off-by: Niels Thykier <niels at thykier.net>
---
 debian/changelog |  3 +++
 dh_installdocs   | 10 ++++++++++
 2 files changed, 13 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 48e5e07..b80d1f3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -69,6 +69,9 @@ debhelper (9.20150101.1) UNRELEASED; urgency=medium
     with "--link-doc" instead of trying to determine the correct
     package version.  Thanks to Stephen Kitt for reporting this
     issue.  (Closes: #747141)
+  * dh_installdocs.1: Document that --link-doc may in some cases
+    require a dir to symlink (or symlink to dir) migration.
+    (Closes: #659044)
 
   [ Bernhard R. Link ]
   * Dh_lib: apply patch from Guillem Jover to support case-insensitive
diff --git a/dh_installdocs b/dh_installdocs
index b35db6a..8ad00bc 100755
--- a/dh_installdocs
+++ b/dh_installdocs
@@ -100,6 +100,16 @@ not be installed.
 is to make the documentation directory of a package be a dangling symlink,
 before calling B<dh_installdocs>.)
 
+B<CAVEAT>: If a previous version of the package was built without this
+option and is now built with it (or vice-versa), it requries a "dir to
+symlink" (or "symlink to dir") migration.  Since debhelper has no
+knowledge of previous versions, you have to enable this migration
+itself.
+
+This can be done by providing a "debian/I<package>.maintscript" file
+and using L<dh_installdeb(1)> to provide the relevant maintainer
+script snippets.
+
 =item I<file> ...
 
 Install these files as documentation into the first package acted on. (Or

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/debhelper.git