Your message dated Sat, 06 May 2017 13:48:45 +0000
with message-id <[email protected]>
and subject line Bug#860091: fixed in debhelper 10.3
has caused the Debian Bug report #860091,
regarding debhelper: Please be more verbose in the dh_link man page
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)


-- 
860091: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=860091
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Package: debhelper
Version: 10.2.3
Severity: wishlist
Tags: patch

Hi,

I didn't find the dh_link man page very helpful when I trued to create a
debian/I<package>.links file. I noticed the following shortcomings:

 - the man page uses the source/destination nomenclature which I find
   quite confusing. I would've thought that the "destination" of a
   symlink is the path that the symlink points to and thus the symlink
   itself must be the source. Indeed it seems to be the other way round.
   It would probably help to at least mention the parallels to the
   nomenclature used in ln(1)

 - the man page talks about "full filename" but actually means a full
   "path". And instead of saying "full" it would probably be less
   ambiguous and more precise to use the word "absolute" instead.

 - Furthermore, the path must be given without the leading slash. This
   is shown in the examples but never mentioned in the text.

 - The documentation for the debian/I<package>.links files never
   mentions the order in which source and destination have to be listed.
   It would also help to reduce confusion to mention that the order is
   the same that would be used for the ln(1) command.

 - If one just searches for how to write a debian/I<package>.links file,
   one easily misses the note that paths must be given absolute and not
   relative to the symlink itself. That the paths inside
   debian/I<package>.links files must be given in an absolute manner is
   more an implicit assumption but instead should be made explicit for
   clarity.

Attached patch addresses all my above concerns and also adds an example
for debian/I<package>.links files in the EXAMPLES section.

I hope it helps!

Thanks!

cheers, josch
diff --git a/dh_link b/dh_link
index 208e8751..f5e87426 100755
--- a/dh_link
+++ b/dh_link
@@ -21,11 +21,11 @@ B<dh_link> is a debhelper program that creates symlinks in 
package build
 directories.
 
 B<dh_link> accepts a list of pairs of source and destination files. The source
-files are the already existing files that will be symlinked from. The
-destination files are the symlinks that will be created. There B<must> be
+files are the already existing files that will be symlinked from (called 
B<target> by L<ln(1)>). The
+destination files are the symlinks that will be created (called B<link name> 
by L<ln(1)>). There B<must> be
 an equal number of source and destination files specified.
 
-Be sure you B<do> specify the full filename to both the source and
+Be sure you B<do> specify the absolute path (without leading slash) to both 
the source and
 destination files (unlike you would do if you were using something like
 L<ln(1)>).
 
@@ -49,6 +49,14 @@ Lists pairs of source and destination files to be symlinked. 
Each pair
 should be put on its own line, with the source and destination separated by
 whitespace.
 
+In each pair the source file (called B<target> by L<ln(1)>) comes first and is
+followed by the destination file (called B<link name> by L<ln(1)>). Thus the
+pairs of source and destination files in each line are give in the same order
+as they would be given to L<ln(1)>.
+
+In contrast to L<ln(1)>, source and destination paths must be absolute without
+a leading slash.
+
 =back
 
 =head1 OPTIONS
@@ -85,6 +93,11 @@ Make F<bar.1> be a symlink to F<foo.1>
 Make F</usr/lib/foo/> be a link to F</var/lib/foo/>, and F<bar.1> be a symlink 
to
 the F<foo.1>
 
+ var/lib/foo usr/lib/foo
+ usr/share/man/man1/foo.1 usr/share/man/man1/bar.1
+
+Same as above but as content for a debian/I<package>.links file.
+
 =cut
 
 init();

--- End Message ---
--- Begin Message ---
Source: debhelper
Source-Version: 10.3

We believe that the bug you reported is fixed in the latest version of
debhelper, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to [email protected],
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Niels Thykier <[email protected]> (supplier of updated debhelper package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing [email protected])


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Format: 1.8
Date: Sat, 06 May 2017 13:29:31 +0000
Source: debhelper
Binary: debhelper dh-systemd
Architecture: source
Version: 10.3
Distribution: experimental
Urgency: medium
Maintainer: Debhelper Maintainers <[email protected]>
Changed-By: Niels Thykier <[email protected]>
Description:
 debhelper  - helper programs for debian/rules
 dh-systemd - debhelper add-on to handle systemd unit files - transitional pack
Closes: 415396 616070 770281 795253 800043 812248 837528 844077 844602 847138 
853881 856688 857028 860091 861627
Changes:
 debhelper (10.3) experimental; urgency=medium
 .
   [ Helmut Grohne ]
   * Supply PKG_CONFIG for cross compilation with the makefile buildsystem.
     (Closes: #853881)
   * Disable stripping during dh_auto_* in makefile buildsystem in compat 11.
     (Closes: #844077)
   * Remove explicit "Multi-Arch: no" stanzas as they are auto-rejected.
     (Closes: #857028)
 .
   [ Niels Thykier ]
   * Dh_Lib.pm: Make getpackages() produce the correct result independently
     of the order of the fields in a given paragraph of debian/control.
     (Closes: #847138)
   * dh_installman: Report installed manpages so the new dh_missing tool
     is informed about them.
   * dh_install: Deprecate --list-missing/--fail-missing in favor of the
     new dh_missing tool.  The options will be removed in compat 11.
   * dh: Run dh_missing by default (in no op mode).
   * dh_prep: Clean up generated files so they work like other temporary
     debhelper files.
   * dh_installinit: Clarify that it might make sense to skip dh_installinit
     for a package if it provides a systemd service but no sysvinit file.
     (Closes: #800043)
   * dh_installinit: Deprecate --no-restart-on-upgrade in favor of the new
     name --no-stop-on-upgrade, which does the same thing but is less
     likely to be confused with --no-restart-after-upgrade and is more
     descriptive of what it actually does.  Thanks to  Simon McVittie and
     Michael Biebl for the help.  (Closes: #837528)
   * debian/rules: Only apply the --no-parallel to dh_auto_test.  The rest
     of debhelper's build appears to work fine with --parallel.
   * dh_systemd_enable.1: Clarify that --no-enable does not control
     whether a service is started and that dh_systemd_start is the tool
     that does that.  (Closes: #770281)
   * autoconf.pm: Set --runstatedir to "/run" in compat 11.  Thanks to
     Michael Biebl for the suggestion.
   * 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.
   * dh_gencontrol: Avoid adding Homepage fields to dbgsym packages.  Avoids
     non-overridable warnings from lintian when there is an issue in the
     homepage field of the original binary.  (Closes: #812248)
   * dh_strip: Fix a check that could cause dh_strip to generate dbgsym
     packages when it should not.
   * dh: Stop loading python-support in all compat levels as dh_pysupport
     has been removed in stretch.
   * python_support.pm: Remove the content with a deprecation warning as
     the module can no longer do anything.
   * dh_installman.1: Improve the manpage to clarify the scope of
     dh_installman and provide an examples.  (Closes: LP: #184156)
   * makefile.pm: Disable parallel installation if libtool is present to
     avoid a race-condition in automake when using libtool.
     (Closes: #861627)
 .
   [ Steven Chamberlain ]
   * When cross-compiling for GNU/kFreeBSD host systems, set
     CMAKE_SYSTEM_NAME to the correct value "kFreeBSD", not "FreeBSD".
     (Closes: #856688)
 .
   [ Felipe Sateler ]
   * dh_systemd_enable.1: Improve the wording of the documentation for
     the --no-enable option.  (Closes: #844602)
 .
   [ Michael Biebl ]
   * Add support for meson + ninja build systems.  (Closes: #795253)
 .
   [ Michael Stapelberg ]
   * dh_missing: New tool to handle --list-missing/--fail-missing.
     (Closes: #415396, #616070)
   * Dh_Lib.pm: Introduce a log_installed_files sub that can be used
     to inform dh_missing that a given file has been installed.
 .
   [ Johannes Schauer ]
   * dh_link.1: Improve the documentation and use ln(1) as a reference
     to make it simpler for people, who are used to the terms from ln.
     (Closes: #860091)
Checksums-Sha1:
 17cc7410f0f79ce9e289514d0f6c34409d8dc2cd 1725 debhelper_10.3.dsc
 2d80c50b69227ae6d252f4044eb20cc53bff0d79 398764 debhelper_10.3.tar.xz
 a04a9ea8b3896c6f504e7cc7c994fe11cef7aa23 4589 debhelper_10.3_source.buildinfo
Checksums-Sha256:
 38451d6b4db456a3d0ce1e0a27e81829f61ad1b47ec45643c5294aaa6999b150 1725 
debhelper_10.3.dsc
 d17c6d1d672113cc869b079015517034516238ec83c447e3be39dd9f10ebf32c 398764 
debhelper_10.3.tar.xz
 1c7885e72e7fea2a4ee61f937cbbafbceb3ca798d314f903ec469f6048106386 4589 
debhelper_10.3_source.buildinfo
Files:
 5105d8877292c9ab3b93642e3ef911dd 1725 devel optional debhelper_10.3.dsc
 83e5e673b4876de586d937c2ea2ec290 398764 devel optional debhelper_10.3.tar.xz
 3739033d54fe541404b3f7de04c2ea8a 4589 devel optional 
debhelper_10.3_source.buildinfo

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEsxMaRR2/33ygW0GXBUu7n32AZEIFAlkN0GUACgkQBUu7n32A
ZEJSTw/9EFZN+z375Q7WdAj6LEiDVoh3InkCQELR4/HQk5D9gXpTzUrKGQrmw5u9
77jxRo05KVny8H4GwtII+ShhYXNwGjnC5DauSVqKlI8Mp820kLfvP8Lwb+QQ4zME
e7T0+aejxjy+1OKIIppv29GLe/lgYaUxlPwkhlKyKodoTKXDfmZyurS5blemcGiA
aj6hl3X9Nv3uxOzXU4511qbJUHZHXSgVqGQNISEsiqetLmjL+DfssEwoufSA9+w4
E2jNp92Email5QT3R4VPISLxUrji5PkoIgxZ98hOmHdq6KL8vRr/WTomARKcW43m
zmcI9+WxzIZRnOr9uEvAJQf+GTCxmyPPmmKbW9xZk3pB1M+BHdzF4h9Yp+mMVHvh
pMIrlOY8BhIonIjgXD/F8gzxp0QkLf6zZ9AW/OneUB3L1Ra5D6dLmFd5PfhonnIA
CsdWZ8NiE4EUF2Z6LOikmaTUt4ls3NW1wpwyHnoHDnegA+MKDdcOph8JOGMwNenO
N3s+bQu044de5///NaJ/pBYluJ1NNc6CyR+OM1y25wS4Ob5qezbEZ8gAI+mI7ooq
FObckHxAxrELONj1NaMU+WzkW9vXcZQMvAWO6sP0vuV0fhP02qhfK6qKJw4HwDpu
UnPhR+9V4CagVwtcbtc+Ye6pcQBfmSGlvcm7SQTG9KwU8lDFlJg=
=OcJH
-----END PGP SIGNATURE-----

--- End Message ---

Reply via email to