5 dh - debhelper command sequencer
10 use Debian::Debhelper::Dh_Lib;
14 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>>]
18 dh runs a sequence of debhelper commands. The supported sequences
19 correspond to the targets of a debian/rules file: "build", "clean",
20 "install", "binary-arch", "binary-indep", and "binary".
22 Commands in the binary-indep sequence are passed the "-i" option to ensure
23 they only work on binary independent packages, and commands in the
24 binary-arch sequences are passed the "-a" option to ensure they only work
25 on architecture dependent packages.
27 Each debhelper command will record when it's successfully run in
28 debian/package.debhelper.log. (Which dh_clean deletes.) So dh can tell
29 which commands have already been run, for which packages, and skip running
32 Each time dh is run, it examines the log, and finds the last logged command
33 that is in the specified sequence. It then continues with the next command
34 in the sequence. The B<--until>, B<--before>, B<--after>, and B<--remaining>
35 options can override this behavior.
37 If debian/rules contains a target with a name like "override_I<dh_command>",
38 then when it gets to that command in the sequence, dh will run that
39 target from the rules file, rather than running the actual command. The
40 override target can then run the command with additional options, or run
41 entirely different commands instead. (Note that to use this feature,
42 you should Build-Depend on debhelper 7.0.50 or above.)
48 =item B<--with> I<addon>[,I<addon>,...]
50 Add the debhelper commands specified by the given addon to appropriate places
51 in the sequence of commands that is run. This option can be repeated more
52 than once, or multiple addons can be listed, separated by commas.
53 This is used when there is a third-party package that provides
54 debhelper commands. See the PROGRAMMING file for documentation about
55 the sequence addon interface.
57 =item B<--without> I<addon>
59 The inverse of --with, disables using the given addon.
61 =item B<--list>, B<-l>
63 List all available addons.
65 =item B<--until> I<cmd>
67 Run commands in the sequence until and including I<cmd>, then stop.
69 =item B<--before> I<cmd>
71 Run commands in the sequence before I<cmd>, then stop.
73 =item B<--after> I<cmd>
75 Run commands in the sequence that come after I<cmd>.
79 Run all commands in the sequence that have yet to be run.
83 All other options passed to dh are passed on to each command it runs. This
84 can be used to set an option like "-v" or "-X" or "-N", as well as for more
87 =head1 COMMAND SPECIFICATION
89 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
90 search for a command in the sequence exactly matching the name, to avoid any
91 ambiguity. If there are multiple substring matches, the last one in the
92 sequence will be used.
100 foreach my $i (0..$#sequence) {
101 if ($command eq $sequence[$i]) {
107 foreach my $i (0..$#sequence) {
108 if ($sequence[$i] =~ /\Q$command\E/) {
113 error "command specification \"$command\" does not match any command in the sequence"
122 To see what commands are included in a sequence, without actually doing
125 dh binary-arch --no-act
127 This is a very simple rules file, for packages where the default sequences of
128 commands work with no additional options.
134 Often you'll want to pass an option to a specific debhelper command. The
135 easy way to do with is by adding an override target for that command.
144 override_dh_installdocs:
145 dh_installdocs README TODO
147 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
148 what to do for a strange package. Here's how to avoid running either
149 and instead run your own commands.
155 override_dh_auto_configure:
158 override_dh_auto_build:
159 make universe-explode-in-delight
161 Another common case is wanting to do something manually before or
162 after a particular debhelper command is run.
168 override_dh_fixperms:
170 chmod 4755 debian/foo/usr/bin/foo
172 If your package is a python package, dh will use dh_pysupport by
173 default. This is how to use dh_pycentral instead.
177 dh --with python-central $@
179 To patch your package using quilt, you can tell dh to use quilt's dh
180 sequence addons like this:
186 Here is an example of overriding where the dh_auto_* commands find
187 the package's source, for a package where the source is located in a
188 subdirectory. It also forces use of perl's Module::Build build system,
189 which can be necessary if debhelper wrongly detects that the package
194 dh --sourcedirectory=src --buildsystem=perl_build $@
198 # Stash this away before init modifies it.
201 # python-support is enabled by default, at least for now
202 # (and comes first so python-central loads later and can disable it).
203 unshift @ARGV, "--with=python-support";
205 # Disable complaints about unknown options for both dh and the commands
206 # it runs. This is done because dh accepts and passes on options that may
207 # be specific to only some debhelper commands.
208 $ENV{DH_IGNORE_UNKNOWN_OPTIONS}=1;
211 "until=s" => \$dh{UNTIL},
212 "after=s" => \$dh{AFTER},
213 "before=s" => \$dh{BEFORE},
214 "remaining" => \$dh{REMAINING},
216 my ($option,$value)=@_;
217 push @{$dh{WITH}},split(",", $value);
220 my ($option,$value)=@_;
221 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
224 "list" => \$dh{LIST},
228 # Definitions of sequences.
230 $sequences{build} = [qw{
236 $sequences{clean} = [qw{
241 $sequences{install} = [@{$sequences{build}}, qw{
288 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
289 $sequences{binary} = [@{$sequences{install}}, qw{
294 $sequences{'binary-arch'} = [@{$sequences{binary}}];
296 # Additional command options
299 # sequence addon interface
304 foreach my $sequence (keys %sequences) {
305 my @list=@{$sequences{$sequence}};
306 next unless grep $existing, @list;
308 foreach my $command (@list) {
309 if ($command eq $existing) {
310 push @new, $new if $offset < 0;
312 push @new, $new if $offset > 0;
318 $sequences{$sequence}=\@new;
329 foreach my $sequence (keys %sequences) {
330 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
337 unshift @{$sequences{$sequence}}, $command;
339 sub add_command_options {
341 push @{$command_opts{$command}}, @_;
343 sub remove_command_options {
346 # Remove only specified options
347 if (my $opts = $command_opts{$command}) {
348 foreach my $opt (@_) {
349 $opts = [ grep { $_ ne $opt } @$opts ];
351 $command_opts{$command} = $opts;
355 # Clear all additional options
356 delete $command_opts{$command};
364 eval q{use File::Spec};
365 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
367 for my $module_path (glob "$path/*.pm") {
368 my $name = basename($module_path);
376 for my $name (sort keys %addons) {
383 foreach my $addon (@{$dh{WITH}}) {
384 my $mod="Debian::Debhelper::Sequence::$addon";
388 error("unable to load addon $addon: $@");
392 # Get the sequence of commands to run.
394 error "specify a sequence to run";
397 if ($sequence eq 'debian/rules' ||
398 $sequence =~ /^override_dh_/) {
399 # make -B causes the rules file to be run as a target
400 # and support completly empty override targets
403 elsif (! exists $sequences{$sequence}) {
404 error "Unknown sequence $sequence (choose from: ".
405 join(" ", sort keys %sequences).")";
407 my @sequence=@{$sequences{$sequence}};
409 # The list of all packages that can be acted on.
410 my @packages=@{$dh{DOPACKAGES}};
412 # Get the options to pass to commands in the sequence.
413 # Filter out options intended only for this program.
415 if ($sequence eq 'binary-arch') {
417 # as an optimisation, remove from the list any packages
418 # that are not arch dependent
419 my %arch_packages = map { $_ => 1 } getpackages("arch");
420 @packages = grep { $arch_packages{$_} } @packages;
422 elsif ($sequence eq 'binary-indep') {
424 # ditto optimisation for arch indep
425 my %indep_packages = map { $_ => 1 } getpackages("indep");
426 @packages = grep { $indep_packages{$_} } @packages;
429 my $opt=shift @ARGV_orig;
430 next if $opt eq $sequence;
431 if ($opt =~ /^--?(after|until|before|with|without)$/) {
435 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
441 # Figure out at what point in the sequence to start for each package.
444 foreach my $package (@packages) {
445 my @log=load_log($package, \%logged);
447 # Run commands in the sequence that come after the
449 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
450 # Write a dummy log entry indicating that the specified
451 # command was, in fact, run. This handles the case where
452 # no commands remain to run after it, communicating to
453 # future dh instances that the specified command should not
455 write_log($sequence[$startpoint{$package}-1], $package);
457 elsif ($dh{REMAINING}) {
458 # Start at the beginning so all remaining commands will get
460 $startpoint{$package}=0;
463 # Find the last logged command that is in the sequence, and
464 # continue with the next command after it. If no logged
465 # command is in the sequence, we're starting at the beginning..
466 $startpoint{$package}=0;
467 COMMAND: foreach my $command (reverse @log) {
468 foreach my $i (0..$#sequence) {
469 if ($command eq $sequence[$i]) {
470 $startpoint{$package}=$i+1;
478 # Figure out what point in the sequence to go to.
479 my $stoppoint=$#sequence;
481 $stoppoint=command_pos($dh{UNTIL}, @sequence);
483 elsif ($dh{BEFORE}) {
484 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
487 # Now run the commands in the sequence.
488 foreach my $i (0..$stoppoint) {
489 # Figure out which packages need to run this command.
491 foreach my $package (@packages) {
492 if ($startpoint{$package} > $i ||
493 $logged{$package}{$sequence[$i]}) {
494 push @exclude, $package;
498 if (@exclude eq @packages) {
499 # Command already done for all packages.
503 run($sequence[$i], \@packages, \@exclude, @options);
508 my @packages=@{shift()};
509 my @exclude=@{shift()};
512 # If some packages are excluded, add flags
513 # to prevent them from being acted on.
514 push @options, map { "-N$_" } @exclude;
516 # Check for override targets in debian/rules and
517 # run them instead of running the command directly.
518 my $override_command;
519 if (rules_explicit_target("override_".$command)) {
520 $override_command=$command;
521 # This passes the options through to commands called
523 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
524 $command="debian/rules";
525 @options="override_".$override_command;
528 # Pass additional command options if any
529 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
532 # 3 space indent lines the command being run up under the
533 # sequence name after "dh ".
534 print " ".escape_shell($command, @options)."\n";
537 my $ret=system($command, @options);
538 if ($ret >> 8 != 0) {
545 if (defined $override_command) {
546 delete $ENV{DH_INTERNAL_OPTIONS};
547 # Need to handle logging for overriden commands here,
548 # because the actual debhelper command may not have
549 # been run by the rules file target.
550 # (But avoid logging for dh_clean since it removes
552 if ($override_command ne 'dh_clean') {
553 my %packages=map { $_ => 1 } @packages;
554 map { delete $packages{$_} } @exclude;
555 write_log($override_command, keys %packages);
565 sub rules_explicit_target {
566 # Checks if a specified target exists as an explicit target
570 if (! $rules_parsed) {
571 my $processing_targets = 0;
572 my $not_a_target = 0;
573 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
575 if ($processing_targets) {
576 if (/^# Not a target:/) {
580 if (!$not_a_target && /^([^#:]+)::?/) {
582 # NOTE: if it is a depenency
583 # of .PHONY it will be
584 # defined too but that's ok.
587 # "Not a target:" is always followed by
588 # a target name, so resetting this one
592 } elsif (/^# Files$/) {
593 $processing_targets = 1;
600 return exists $targets{$target};
609 This program is a part of debhelper.
613 Joey Hess <joeyh@debian.org>