summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiels Thykier <niels@thykier.net>2022-10-08 15:56:39 +0000
committerNiels Thykier <niels@thykier.net>2022-10-08 15:56:39 +0000
commitd733559ad93681d87367fa5872962f2e2f17aeb1 (patch)
tree8b8e928738e1276aee34ee81c8676d883b116ddc
parent05a56612735ab5b68742347b052100eb0fe544a6 (diff)
dh_installexamples: Explicit recommend `examples/*` over `examples`
Closes: #1000384 Signed-off-by: Niels Thykier <niels@thykier.net>
-rw-r--r--debian/changelog4
-rwxr-xr-xdh_installexamples4
2 files changed, 8 insertions, 0 deletions
diff --git a/debian/changelog b/debian/changelog
index 4c5b0e05..cbb69b58 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -62,6 +62,10 @@ debhelper (13.10) UNRELEASED; urgency=medium
installed. Third-party tools should use the
`--on-behalf-of-cmd` to have their tool name recorded.
(Closes: #972724)
+ * dh_installexamples: Explicitly recommend `examples/*` over
+ `examples` as content for the `debian/<pkg>.examples` file
+ to avoid the triggering `.../examples/examples` case.
+ (Closes: #1000384)
[ Translations ]
* Update Portuguese translation (Américo Monteiro)
diff --git a/dh_installexamples b/dh_installexamples
index f0c0b4fb..ce970ac8 100755
--- a/dh_installexamples
+++ b/dh_installexamples
@@ -36,6 +36,10 @@ directory (or wherever you've told it to look using B<--sourcedir>).
Lists example files or directories to be installed.
+If upstream provides an F<examples> directory, you will often want to use B<examples/*> rather
+than B<examples> in this file. The latter would create
+F<< /usr/share/doc/I<package>/examples/examples >>, which is rarely what you want.
+
Supports substitution variables in compat 13 and later as
documented in L<debhelper(7)>.