dh: Add --list option to list available addons.

[debhelper.git] / dh

diff --git a/dh b/dh
index 8639ed074311b418b2d10b1cf04835491e2042c5..2e7385f4ec7f286bd197c53bc388087a899fc5dd 100755 (executable)
--- a/dh
+++ b/dh
@@ -8,10 +8,11 @@ dh - debhelper command sequencer
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
 
 use strict;
 use Debian::Debhelper::Dh_Lib;

+use File::Spec;

 
 =head1 SYNOPSIS
 
 
 =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<--list>] [B<--until> I<cmd>] [B<--before> I<cmd>] [B<--after> I<cmd>] [B<--remaining>] [S<I<debhelper options>>]

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -45,13 +46,22 @@ you should Build-Depend on debhelper 7.0.50 or above.)
 
 =over 4
 
 
 =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
 
 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<--list>, B<-l>
+
+List all available addons.

 
 =item B<--until> I<cmd>
 
 
 =item B<--until> I<cmd>
 


@@ -82,28 +92,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.
 
 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 {
 =cut
 
 sub command_pos {


@@ -189,11 +177,37 @@ default. This is how to use dh_pycentral instead.
        %:
                dh --with python-central $@
 
        %:
                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;
 
 =cut
 
 # Stash this away before init modifies it.
 my @ARGV_orig=@ARGV;
 

+# 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},
 init(options => {
        "until=s" => \$dh{UNTIL},
        "after=s" => \$dh{AFTER},


@@ -201,8 +215,14 @@ init(options => {
        "remaining" => \$dh{REMAINING},
        "with=s" => sub {
                my ($option,$value)=@_;
        "remaining" => \$dh{REMAINING},
        "with=s" => sub {
                my ($option,$value)=@_;

-               push @{$dh{WITH}},$value;
+               push @{$dh{WITH}},split(",", $value);
+       },
+       "without=s" => sub {
+               my ($option,$value)=@_;
+               @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};

        },
        },

+       "l" => \$dh{LIST},
+       "list" => \$dh{LIST},

 });
 inhibit_log();
 
 });
 inhibit_log();
 


@@ -251,11 +271,9 @@ $sequences{install} = [@{$sequences{build}}, qw{
        dh_installxfonts
        dh_bugfiles
        dh_lintian
        dh_installxfonts
        dh_bugfiles
        dh_lintian

-       dh_desktop

        dh_gconf
        dh_icons
        dh_perl
        dh_gconf
        dh_icons
        dh_perl

-       dh_scrollkeeper

        dh_usrlocal
 
        dh_link
        dh_usrlocal
 
        dh_link


@@ -276,9 +294,6 @@ $sequences{binary} = [@{$sequences{install}}, qw{
 }, @b];
 $sequences{'binary-arch'} = [@{$sequences{binary}}];
 
 }, @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;
 # sequence addon interface
 sub _insert {
        my $offset=shift;


@@ -314,6 +329,34 @@ sub remove_command {
        }
        
 }
        }
        
 }

+sub add_command {
+       my $command=shift;
+       my $sequence=shift;
+       unshift @{$sequences{$sequence}}, $command;
+}
+
+if ($dh{LIST}) {
+       my %addons;
+
+       for my $inc (@INC) {
+               my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
+               if (-d $path) {
+                       for my $module_path (glob "$path/*.pm") {
+                               my $name = basename($module_path);
+                               $name =~ s/\.pm$//;
+                               $name =~ s/_/-/g;
+                               $addons{$name} = 1;
+                       }
+               }
+       }
+
+       for my $name (sort keys %addons) {
+               print "$name\n";
+       }
+
+       exit 0;
+}
+

 foreach my $addon (@{$dh{WITH}}) {
        my $mod="Debian::Debhelper::Sequence::$addon";
        $mod=~s/-/_/g;
 foreach my $addon (@{$dh{WITH}}) {
        my $mod="Debian::Debhelper::Sequence::$addon";
        $mod=~s/-/_/g;


@@ -362,11 +405,11 @@ elsif ($sequence eq 'binary-indep') {
 while (@ARGV_orig) {
        my $opt=shift @ARGV_orig;
        next if $opt eq $sequence;
 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;
        }
                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;
                next;
        }
        push @options, $opt;


@@ -376,7 +419,7 @@ while (@ARGV_orig) {
 my %logged;
 my %startpoint;
 foreach my $package (@packages) {
 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.
        if ($dh{AFTER}) {
                # Run commands in the sequence that come after the
                # specified command.


@@ -386,7 +429,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.
                # no commands remain to run after it, communicating to
                # future dh instances that the specified command should not
                # be run again.

-               writelog($sequence[$startpoint{$package}-1], $package);
+               write_log($sequence[$startpoint{$package}-1], $package);

        }
        elsif ($dh{REMAINING}) {
                # Start at the beginning so all remaining commands will get
        }
        elsif ($dh{REMAINING}) {
                # Start at the beginning so all remaining commands will get


@@ -454,7 +497,7 @@ sub run {
                $override_command=$command;
                # This passes the options through to commands called
                # inside the target.
                $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;
        }
                $command="debian/rules";
                @options="override_".$override_command;
        }


@@ -477,32 +520,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.
                        # 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;
-                       writelog($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 {
-       Debian::Debhelper::Dh_Lib::write_log(@_);
-}
-

 {
 my %targets;
 my $rules_parsed;
 {
 my %targets;
 my $rules_parsed;