Improve error messages when child commands fail.

[debhelper.git] / Debian / Debhelper / Dh_Lib.pm

diff --git a/Debian/Debhelper/Dh_Lib.pm b/Debian/Debhelper/Dh_Lib.pm
index dceec786e335316f6822b4e4bc0ab085392e4b64..a11c36a37ce7b5bfd8a900ccd307a516d6e78e07 100644 (file)
--- a/Debian/Debhelper/Dh_Lib.pm
+++ b/Debian/Debhelper/Dh_Lib.pm
@@ -2,7 +2,7 @@
 #
 # Library functions for debhelper programs, perl version.
 #
-# Joey Hess, GPL copyright 1997-2000.
+# Joey Hess, GPL copyright 1997-2008.
 
 package Debian::Debhelper::Dh_Lib;
 use strict;
@@ -14,34 +14,24 @@ use vars qw(@ISA @EXPORT %dh);
            &pkgfile &pkgext &pkgfilename &isnative &autoscript &filearray
            &filedoublearray &getpackages &basename &dirname &xargs %dh
            &compat &addsubstvar &delsubstvar &excludefile &package_arch
-           &is_udeb &udeb_filename &debhelper_script_subst &escape_shell);
+           &is_udeb &udeb_filename &debhelper_script_subst &escape_shell
+           &inhibit_log);
 
 my $max_compat=7;
 
 sub init {
-       # If DH_OPTIONS is set, prepend it @ARGV.
-       if (defined($ENV{DH_OPTIONS})) {
-               # Ignore leading/trailing whitespace.
-               $ENV{DH_OPTIONS}=~s/^\s+//;
-               $ENV{DH_OPTIONS}=~s/\s+$//;
-               unshift @ARGV,split(/\s+/,$ENV{DH_OPTIONS});
-       }
+       my %params=@_;
 
-       # Check to see if an argument on the command line starts with a dash.
-       # if so, we need to pass this off to the resource intensive 
+       # Check to see if an option line starts with a dash,
+       # or DH_OPTIONS is set.
+       # If so, we need to pass this off to the resource intensive 
        # Getopt::Long, which I'd prefer to avoid loading at all if possible.
-       my $parseopt=undef;
-       my $arg;
-       foreach $arg (@ARGV) {
-               if ($arg=~m/^-/) {
-                       $parseopt=1;
-                       last;
-               }       
-       }
-       if ($parseopt) {
+       if ((defined $ENV{DH_OPTIONS} && length $ENV{DH_OPTIONS}) ||
+           (defined $ENV{DH_INTERNAL_OPTIONS} && length $ENV{DH_INTERNAL_OPTIONS}) ||
+           grep /^-/, @ARGV) {
                eval "use Debian::Debhelper::Dh_Getopt";
-               error($!) if $@;
-               %dh=Debian::Debhelper::Dh_Getopt::parseopts();
+               error($@) if $@;
+               Debian::Debhelper::Dh_Getopt::parseopts($params{options});
        }
 
        # Another way to set excludes.
@@ -110,20 +100,28 @@ sub init {
 
 # Run at exit. Add the command to the log files for the packages it acted
 # on, if it's exiting successfully.
+my $write_log=1;
 sub END {
-       if ($? == 0) {
-               my $cmd=basename($0);
-               # dh_clean deletes the log, so should not recreate it at
-               # the end
-               if ($cmd ne "dh_clean") {
-                       foreach my $package (@{$dh{DOPACKAGES}}) {
-                               my $ext=pkgext($package);
-                               open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
-                               print LOG $cmd."\n";
-                               close LOG;
-                       }
-               }
+       if ($? == 0 && $write_log) {
+               write_log(basename($0), @{$dh{DOPACKAGES}});
        }
+}      
+
+sub write_log {
+       my $cmd=shift;
+       my @packages=@_;
+
+       foreach my $package (@packages) {
+               my $ext=pkgext($package);
+               my $log="debian/${ext}debhelper.log";
+               open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
+               print LOG $cmd."\n";
+               close LOG;
+       }
+}
+
+sub inhibit_log {
+       $write_log=0;
 }
 
 # Pass it an array containing the arguments of a shell command like would
@@ -164,8 +162,7 @@ sub doit {
        verbose_print(escape_shell(@_));
 
        if (! $dh{NO_ACT}) {
-               my $ret=system(@_);
-               $ret == 0 || error("command returned error code $ret");
+               system(@_) == 0 || _error_exitcode($_[0]);
        }
 }
 
@@ -178,11 +175,23 @@ sub complex_doit {
        
        if (! $dh{NO_ACT}) {
                # The join makes system get a scalar so it forks off a shell.
-               system(join(" ",@_)) == 0
-                       || error("command returned error code");
+               system(join(" ", @_)) == 0 || _error_exitcode(join(" ", @_))
        }                       
 }
 
+sub _error_exitcode {
+       my $command=shift;
+       if ($? == -1) {
+               error("$command failed to to execute: $!");
+       }
+       elsif ($? & 127) {
+               error("$command died with signal ".($? & 127));
+        }
+       else {
+               error("$command returned exit code ".($? >> 8));
+       }
+}
+
 # Run a command that may have a huge number of arguments, like xargs does.
 # Pass in a reference to an array containing the arguments, and then other
 # parameters that are the command and any parameters that should be passed to