]> git.donarmstrong.com Git - debhelper.git/blobdiff - dh
Use ASCII RS for separating options in DH_INTERNAL_OPTIONS.
[debhelper.git] / dh
diff --git a/dh b/dh
index 1ec46ba937788c3efbeaf5ddf3dc23d8a0ad74d3..c34a5a0273e952f359e8b92cf14c19ab7f73c24b 100755 (executable)
--- a/dh
+++ b/dh
@@ -11,7 +11,7 @@ use Debian::Debhelper::Dh_Lib;
 
 =head1 SYNOPSIS
 
-B<dh> sequence [B<--with> I<addon>] [B<--until> I<cmd>] [B<--before> I<cmd>] [B<--after> I<cmd>] [B<--remaining>] [S<I<debhelper options>>]
+B<dh> sequence [B<--with> I<addon>[,I<addon>,...]] [B<--until> I<cmd>] [B<--before> I<cmd>] [B<--after> I<cmd>] [B<--remaining>] [S<I<debhelper options>>]
 
 =head1 DESCRIPTION
 
@@ -39,19 +39,24 @@ then when it gets to that command in the sequence, dh will run that
 target from the rules file, rather than running the actual command. The
 override target can then run the command with additional options, or run
 entirely different commands instead. (Note that to use this feature,
-you should Build-Depend on debhelper 7.2 or above.)
+you should Build-Depend on debhelper 7.0.50 or above.)
 
 =head1 OPTIONS
 
 =over 4
 
-=item B<--with> I<addon>
+=item B<--with> I<addon>[,I<addon>,...]
 
 Add the debhelper commands specified by the given addon to appropriate places
 in the sequence of commands that is run. This option can be repeated more
-than once, and is used when there is a third-party package that provides
-debhelper commands. See "SEQUENCE ADDONS" below for documentation about what
-such packages should do to be supported by --with.
+than once, or multiple addons can be listed, separated by commas.
+This is used when there is a third-party package that provides
+debhelper commands. See the PROGRAMMING file for documentation about
+the sequence addon interface.
+
+=item B<--without> I<addon>
+
+The inverse of --with, disables using the given addon.
 
 =item B<--until> I<cmd>
 
@@ -82,28 +87,6 @@ search for a command in the sequence exactly matching the name, to avoid any
 ambiguity. If there are multiple substring matches, the last one in the
 sequence will be used.
 
-=head1 SEQUENCE ADDONS
-
-When B<--with> I<addon> is used, dh loads the perl module
-Debian::Debhelper::Sequence::I<addon>. Two functions are provided to let
-the module add its commands to sequences:
-
-=over 4
-
-=item Debian::Debhelper::Dh_Lib::insert_before(existing_command, new_command)
-
-Insert I<new_command> in sequences before I<existing_command>.
-
-=item Debian::Debhelper::Dh_Lib::insert_after(existing_command, new_command)
-
-Insert I<new_command> in sequences after I<existing_command>.
-
-=item Debian::Debhelper::Dh_Lib::remove_command(existing_command)
-
-Remove I<existing_command> from the list of commands to run.
-
-=back
-
 =cut
 
 sub command_pos {
@@ -182,21 +165,58 @@ after a particular debhelper command is run.
                dh_fixperms
                chmod 4755 debian/foo/usr/bin/foo
 
-If the package's source tree might get files with names
-like build or clean in it, the rules file would not
-run targets with the same names. This issue can be worked
-around by passing -B to make.
+If your package is a python package, dh will use dh_pysupport by
+default. This is how to use dh_pycentral instead.
 
-       #!/usr/bin/make -Bf
+       #!/usr/bin/make -f
        %:
-               dh $@
+               dh --with python-central $@
+
+To patch your package using quilt, you can tell dh to use quilt's dh
+sequence addons like this:
+       
+       #!/usr/bin/make -f
+       %:
+               dh --with quilt $@
+
+Here is an example of overriding where the dh_auto_* commands find
+the package's source, for a package where the source is located in a
+subdirectory. It also forces use of perl's Module::Build build system,
+which can be necessary if debhelper wrongly detects that the package
+uses MakeMaker.
+
+       #!/usr/bin/make -f
+       %:
+               dh --sourcedirectory=src --buildsystem=perl_build $@
 
 =cut
 
 # Stash this away before init modifies it.
 my @ARGV_orig=@ARGV;
 
-init();
+# python-support is enabled by default, at least for now
+# (and comes first so python-central loads later and can disable it).
+unshift @ARGV, "--with=python-support";
+               
+# Disable complaints about unknown options for both dh and the commands
+# it runs. This is done because dh accepts and passes on options that may
+# be specific to only some debhelper commands.
+$ENV{DH_IGNORE_UNKNOWN_OPTIONS}=1;
+
+init(options => {
+       "until=s" => \$dh{UNTIL},
+       "after=s" => \$dh{AFTER},
+       "before=s" => \$dh{BEFORE},
+       "remaining" => \$dh{REMAINING},
+       "with=s" => sub {
+               my ($option,$value)=@_;
+               push @{$dh{WITH}},split(",", $value);
+       },
+       "without=s" => sub {
+               my ($option,$value)=@_;
+               @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
+       },
+});
 inhibit_log();
 
 # Definitions of sequences.
@@ -242,12 +262,11 @@ $sequences{install} = [@{$sequences{build}}, qw{
        dh_installudev
        dh_installwm
        dh_installxfonts
+       dh_bugfiles
        dh_lintian
-       dh_desktop
        dh_gconf
        dh_icons
        dh_perl
-       dh_scrollkeeper
        dh_usrlocal
 
        dh_link
@@ -268,9 +287,6 @@ $sequences{binary} = [@{$sequences{install}}, qw{
 }, @b];
 $sequences{'binary-arch'} = [@{$sequences{binary}}];
 
-# --with python-support is enabled by default, at least for now
-unshift @{$dh{WITH}}, "python-support";
-
 # sequence addon interface
 sub _insert {
        my $offset=shift;
@@ -354,11 +370,11 @@ elsif ($sequence eq 'binary-indep') {
 while (@ARGV_orig) {
        my $opt=shift @ARGV_orig;
        next if $opt eq $sequence;
-       if ($opt =~ /^--?(after|until|before|with)$/) {
+       if ($opt =~ /^--?(after|until|before|with|without)$/) {
                shift @ARGV_orig;
                next;
        }
-       elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with)=)/) {
+       elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
                next;
        }
        push @options, $opt;
@@ -368,7 +384,7 @@ while (@ARGV_orig) {
 my %logged;
 my %startpoint;
 foreach my $package (@packages) {
-       my @log=loadlog($package);
+       my @log=load_log($package, \%logged);
        if ($dh{AFTER}) {
                # Run commands in the sequence that come after the
                # specified command.
@@ -378,7 +394,7 @@ foreach my $package (@packages) {
                # no commands remain to run after it, communicating to
                # future dh instances that the specified command should not
                # be run again.
-               writelog($package, $sequence[$startpoint{$package}-1]);
+               write_log($sequence[$startpoint{$package}-1], $package);
        }
        elsif ($dh{REMAINING}) {
                # Start at the beginning so all remaining commands will get
@@ -435,6 +451,10 @@ sub run {
        my @exclude=@{shift()};
        my @options=@_;
        
+       # If some packages are excluded, add flags
+       # to prevent them from being acted on.
+       push @options, map { "-N$_" } @exclude;
+
        # Check for override targets in debian/rules and
        # run them instead of running the command directly.
        my $override_command;
@@ -442,15 +462,10 @@ sub run {
                $override_command=$command;
                # This passes the options through to commands called
                # inside the target.
-               $ENV{DH_INTERNAL_OPTIONS}=join(" ", @options);
+               $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
                $command="debian/rules";
                @options="override_".$override_command;
        }
-       else {
-               # If some packages are excluded, add flags
-               # to prevent them from being acted on.
-               push @options, map { "-N$_" } @exclude;
-       }
 
        # 3 space indent lines the command being run up under the 
        # sequence name after "dh ".
@@ -470,38 +485,17 @@ sub run {
                        # Need to handle logging for overriden commands here,
                        # because the actual debhelper command may not have
                        # been run by the rules file target.
-                       my %packages=map { $_ => 1 } @packages;
-                       map { delete $packages{$_} } @exclude;
-                       Debian::Debhelper::Dh_Lib::write_log($override_command, keys %packages);
+                       # (But avoid logging for dh_clean since it removes
+                       # the log earlier.)
+                       if ($override_command ne 'dh_clean') {
+                               my %packages=map { $_ => 1 } @packages;
+                               map { delete $packages{$_} } @exclude;
+                               write_log($override_command, keys %packages);
+                       }
                }
        }
 }
 
-sub loadlog {
-       my $package=shift;
-       my $ext=pkgext($package);
-       
-       my @log;
-       open(LOG, "<", "debian/${ext}debhelper.log") || return;
-       while (<LOG>) {
-               chomp;
-               push @log, $_;
-               $logged{$package}{$_}=1;
-       }
-       close LOG;
-       return @log;
-}
-               
-sub writelog {
-       my $package=shift;
-       my $cmd=shift;
-       my $ext=pkgext($package);
-       
-       open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
-       print LOG $cmd."\n";
-       close LOG;
-}
-
 {
 my %targets;
 my $rules_parsed;
@@ -514,7 +508,7 @@ sub rules_explicit_target {
        if (! $rules_parsed) {  
                my $processing_targets = 0;
                my $not_a_target = 0;
-               open(MAKE, "make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
+               open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
                while (<MAKE>) {
                        if ($processing_targets) {
                                if (/^# Not a target:/) {