[debhelper-devel] [debhelper] 01/01: dh_strip: Document current rather than future ddeb state

[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 5eff70135eb00fe6bf19dda6071be70fdff62002
Author: Niels Thykier <niels at thykier.net>
Date:   Sun Aug 30 19:29:12 2015 +0200

    dh_strip: Document current rather than future ddeb state
    
    Signed-off-by: Niels Thykier <niels at thykier.net>
---
 debian/changelog |  4 ++++
 dh_strip         | 16 ++++++++++++++--
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index f28a8b3..37a9432 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -32,6 +32,10 @@ debhelper (9.20150811+unreleased) UNRELEASED; urgency=medium
     (see #575059, #452273 for why it does not produce the
      correct extesion).  (Closes: #516721, #677353)
   * Dh_Lib.pm: Drop now unused "udeb_filename" subroutine.
+  * dh_strip.1: Correct the documentation about ddebs to
+    reflect the current implementation (rather than the
+    desired "state").  Thanks to Jakub Wilk for the report.
+    (Closes: #797002)
 
   [ Paul Tagliamonte ]
   * dh_gencontrol: Put debug debs back in the "debug" section.
diff --git a/dh_strip b/dh_strip
index 30eb570..2f20c0d 100755
--- a/dh_strip
+++ b/dh_strip
@@ -45,6 +45,8 @@ things to exclude.
 
 =item B<--dbg-package=>I<package>
 
+=begin comment
+
 B<This option is a now special purpose option that you normally do not
 need>.  In most cases, there should be little reason to use this
 option for new source packages as debhelper generates automatic debug
@@ -52,6 +54,8 @@ packages ("ddebs").  B<If you have a manual --dbg-package> that you
 want to migrate to the automatic ddeb, please see the
 B<--ddeb-migration> option.
 
+=end
+
 Causes B<dh_strip> to save debug symbols stripped from the packages it acts on
 as independent files in the package build directory of the specified debugging
 package.
@@ -97,8 +101,16 @@ Examples:
 =item B<--ddebs>, B<--no-ddebs>
 
 Control whether B<dh_strip> should be creating ddebs when possible.
-By default, B<dh_strip> will attempt to build ddebs and this option is
-primarily useful for disabling this.
+
+Once the Debian archive supports ddebs, debhelper will generate ddebs
+by default.  Until then, this option does nothing except allow you to
+pre-emptively disable ddebs if you know the generated ddebs will not
+work for your package.
+
+If you want to test the ddebs feature, you can set the environment
+variable I<DH_BUILD_DDEBS> to 1.  Keep in mind that the Debian archive
+does B<not> accept them yet.  This variable is only a temporary safe
+guard and will be removed once the archive is ready to accept ddebs.
 
 =back
 

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