[debhelper-devel] [debhelper] 01/01: dh_installdocs: Document another --link-doc limitation

[Niels Thykier]

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

nthykier pushed a commit to branch master
in repository debhelper.

commit 7e7f4fcd06eb9533e4db1b7c9b0147465b0324f4
Author: Niels Thykier <niels at thykier.net>
Date:   Fri Apr 28 21:25:46 2017 +0000

    dh_installdocs: Document another --link-doc limitation
    
    Signed-off-by: Niels Thykier <niels at thykier.net>
---
 debian/changelog | 3 +++
 dh_installdocs   | 8 +++++++-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index 322353a..501fe83 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -37,6 +37,9 @@ debhelper (10.3) UNRELEASED; urgency=medium
   * dh_fixperms: Refactor to reduce the constant overhead a bit and
     extract some patterns into data list.  The latter hopefully reducing
     the need for tweaking dh_fixperms' logic.
+  * dh_installdocs: Document that --link-doc has limitations on source and
+    target package plus that compat 10 will reject unsupported
+    combinations.
 
   [ Steven Chamberlain ]
   * When cross-compiling for GNU/kFreeBSD host systems, set
diff --git a/dh_installdocs b/dh_installdocs
index 98f5418..42e49a4 100755
--- a/dh_installdocs
+++ b/dh_installdocs
@@ -110,7 +110,7 @@ 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
+B<CAVEAT 1>: If a previous version of the package was built without this
 option and is now built with it (or vice-versa), it requires a "dir to
 symlink" (or "symlink to dir") migration.  Since debhelper has no
 knowledge of previous versions, you have to enable this migration
@@ -120,6 +120,12 @@ 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.
 
+B<CAVEAT 2>: The use of B<--link-doc> should only be done when the
+packages have same "architecture" type.  A link from a architecture
+independent package to a architecture dependent package (or vice
+versa) will not work.  Since compat 10, debhelper will actively reject
+unsupported combinations.
+
 =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/debhelper/debhelper.git