[devscripts] 01/01: origtargz: Clarify manpage about when the tarball is unpacked. (Closes: #820494)

[Christoph Berg]

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

myon pushed a commit to branch master
in repository devscripts.

commit b59a30f6c75b3771d5d323e337d49f455c320ef6
Author: Christoph Berg <myon at debian.org>
Date:   Sun Apr 10 23:47:22 2016 +0200

    origtargz: Clarify manpage about when the tarball is unpacked. (Closes: #820494)
---
 debian/changelog     |  4 ++++
 scripts/origtargz.pl | 15 ++++++++-------
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 99ef9da..2db7332 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -13,6 +13,10 @@ devscripts (2.16.3) UNRELEASED; urgency=medium
     (as of 2016-04-02) listed on buildd.debian.org
   * Support xz compressed files in dd-list
 
+  [ Christoph Berg ]
+  * origtargz: Clarify manpage about when the tarball is unpacked.
+    (Closes: #820494)
+
  -- James McCoy <jamessan at debian.org>  Sun, 20 Mar 2016 12:26:04 -0400
 
 devscripts (2.16.2) unstable; urgency=medium
diff --git a/scripts/origtargz.pl b/scripts/origtargz.pl
index 4c404a5..6fba5fb 100755
--- a/scripts/origtargz.pl
+++ b/scripts/origtargz.pl
@@ -33,11 +33,12 @@ origtargz - fetch the orig tarball of a Debian package from various sources, and
 
 =head1 DESCRIPTION
 
-B<origtargz> downloads the orig tarball of a Debian package, and optionally
-unpacks it into the current directory. The version number to be used is
-determined from F<debian/changelog>. The main use for B<origtargz> is with
-debian-dir-only repository checkouts. It should be invoked from the top level
-directory of an unpacked Debian source package.
+B<origtargz> downloads the orig tarball of a Debian package, and also unpacks
+it into the current directory, if it just contains a F<debian> directory. The
+main use for B<origtargz> is with debian-dir-only repository checkouts, but it
+is useful as a general tarball download wrapper. The version number for the
+tarball to be downloaded is determined from F<debian/changelog>. It should be
+invoked from the top level directory of an unpacked Debian source package.
 
 Various download locations are tried:
 
@@ -74,8 +75,8 @@ for the patch system in use (e.g. source format "3.0 (quilt)"), and will even
 remove all patches from the package when no patch system is in use (the
 original "1.0" source format).
 
-The default behavior is to unpack the orig tarball on the first invocation of
-B<origtargz> in a debian-dir-only checkout.
+The default behavior is to unpack the orig tarball if the current directory
+is empty except for a F<debian> directory and the VCS files mentioned above.
 
 =head1 NOTES
 

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