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 # If make is using a jobserver, but it is not available
229 # to this process, clean out MAKEFLAGS. This avoids
230 # ugly warnings when calling make.
231 if (is_make_jobserver_unavailable()) {
232 clean_jobserver_makeflags();
235 # Definitions of sequences.
237 $sequences{build} = [qw{
243 $sequences{clean} = [qw{
248 $sequences{install} = [@{$sequences{build}}, qw{
294 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
295 $sequences{binary} = [@{$sequences{install}}, qw{
300 $sequences{'binary-arch'} = [@{$sequences{binary}}];
302 # Additional command options
305 # sequence addon interface
310 foreach my $sequence (keys %sequences) {
311 my @list=@{$sequences{$sequence}};
312 next unless grep $existing, @list;
314 foreach my $command (@list) {
315 if ($command eq $existing) {
316 push @new, $new if $offset < 0;
318 push @new, $new if $offset > 0;
324 $sequences{$sequence}=\@new;
335 foreach my $sequence (keys %sequences) {
336 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
343 unshift @{$sequences{$sequence}}, $command;
345 sub add_command_options {
347 push @{$command_opts{$command}}, @_;
349 sub remove_command_options {
352 # Remove only specified options
353 if (my $opts = $command_opts{$command}) {
354 foreach my $opt (@_) {
355 $opts = [ grep { $_ ne $opt } @$opts ];
357 $command_opts{$command} = $opts;
361 # Clear all additional options
362 delete $command_opts{$command};
370 eval q{use File::Spec};
371 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
373 for my $module_path (glob "$path/*.pm") {
374 my $name = basename($module_path);
382 for my $name (sort keys %addons) {
389 foreach my $addon (@{$dh{WITH}}) {
390 my $mod="Debian::Debhelper::Sequence::$addon";
394 error("unable to load addon $addon: $@");
398 # Get the sequence of commands to run.
400 error "specify a sequence to run";
403 if ($sequence eq 'debian/rules' ||
404 $sequence =~ /^override_dh_/) {
405 # make -B causes the rules file to be run as a target
406 # and support completly empty override targets
409 elsif (! exists $sequences{$sequence}) {
410 error "Unknown sequence $sequence (choose from: ".
411 join(" ", sort keys %sequences).")";
413 my @sequence=@{$sequences{$sequence}};
415 # The list of all packages that can be acted on.
416 my @packages=@{$dh{DOPACKAGES}};
418 # Get the options to pass to commands in the sequence.
419 # Filter out options intended only for this program.
421 if ($sequence eq 'binary-arch') {
423 # as an optimisation, remove from the list any packages
424 # that are not arch dependent
425 my %arch_packages = map { $_ => 1 } getpackages("arch");
426 @packages = grep { $arch_packages{$_} } @packages;
428 elsif ($sequence eq 'binary-indep') {
430 # ditto optimisation for arch indep
431 my %indep_packages = map { $_ => 1 } getpackages("indep");
432 @packages = grep { $indep_packages{$_} } @packages;
435 my $opt=shift @ARGV_orig;
436 next if $opt eq $sequence;
437 if ($opt =~ /^--?(after|until|before|with|without)$/) {
441 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
447 # Figure out at what point in the sequence to start for each package.
450 foreach my $package (@packages) {
451 my @log=load_log($package, \%logged);
453 # Run commands in the sequence that come after the
455 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
456 # Write a dummy log entry indicating that the specified
457 # command was, in fact, run. This handles the case where
458 # no commands remain to run after it, communicating to
459 # future dh instances that the specified command should not
461 write_log($sequence[$startpoint{$package}-1], $package);
463 elsif ($dh{REMAINING}) {
464 # Start at the beginning so all remaining commands will get
466 $startpoint{$package}=0;
469 # Find the last logged command that is in the sequence, and
470 # continue with the next command after it. If no logged
471 # command is in the sequence, we're starting at the beginning..
472 $startpoint{$package}=0;
473 COMMAND: foreach my $command (reverse @log) {
474 foreach my $i (0..$#sequence) {
475 if ($command eq $sequence[$i]) {
476 $startpoint{$package}=$i+1;
484 # Figure out what point in the sequence to go to.
485 my $stoppoint=$#sequence;
487 $stoppoint=command_pos($dh{UNTIL}, @sequence);
489 elsif ($dh{BEFORE}) {
490 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
493 # Now run the commands in the sequence.
494 foreach my $i (0..$stoppoint) {
495 # Figure out which packages need to run this command.
497 foreach my $package (@packages) {
498 if ($startpoint{$package} > $i ||
499 $logged{$package}{$sequence[$i]}) {
500 push @exclude, $package;
504 if (@exclude eq @packages) {
505 # Command already done for all packages.
509 run($sequence[$i], \@packages, \@exclude, @options);
514 my @packages=@{shift()};
515 my @exclude=@{shift()};
518 # If some packages are excluded, add flags
519 # to prevent them from being acted on.
520 push @options, map { "-N$_" } @exclude;
522 # Check for override targets in debian/rules and
523 # run them instead of running the command directly.
524 my $override_command;
525 if (rules_explicit_target("override_".$command)) {
526 $override_command=$command;
527 # This passes the options through to commands called
529 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
530 $command="debian/rules";
531 @options="override_".$override_command;
534 # Pass additional command options if any
535 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
538 # 3 space indent lines the command being run up under the
539 # sequence name after "dh ".
540 print " ".escape_shell($command, @options)."\n";
543 my $ret=system($command, @options);
544 if ($ret >> 8 != 0) {
551 if (defined $override_command) {
552 delete $ENV{DH_INTERNAL_OPTIONS};
553 # Need to handle logging for overriden commands here,
554 # because the actual debhelper command may not have
555 # been run by the rules file target.
556 # (But avoid logging for dh_clean since it removes
558 if ($override_command ne 'dh_clean') {
559 my %packages=map { $_ => 1 } @packages;
560 map { delete $packages{$_} } @exclude;
561 write_log($override_command, keys %packages);
571 sub rules_explicit_target {
572 # Checks if a specified target exists as an explicit target
576 if (! $rules_parsed) {
577 my $processing_targets = 0;
578 my $not_a_target = 0;
579 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
581 if ($processing_targets) {
582 if (/^# Not a target:/) {
586 if (!$not_a_target && /^([^#:]+)::?/) {
588 # NOTE: if it is a depenency
589 # of .PHONY it will be
590 # defined too but that's ok.
593 # "Not a target:" is always followed by
594 # a target name, so resetting this one
598 } elsif (/^# Files$/) {
599 $processing_targets = 1;
606 return exists $targets{$target};
615 This program is a part of debhelper.
619 Joey Hess <joeyh@debian.org>