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 would normally run I<dh_command>, dh will instead call that
39 target. The override target can then run the command with additional options,
40 or run entirely different commands instead. See examples below. (Note that to
41 use this feature, you should Build-Depend on debhelper 7.0.50 or above.)
47 =item B<--with> I<addon>[,I<addon>,...]
49 Add the debhelper commands specified by the given addon to appropriate places
50 in the sequence of commands that is run. This option can be repeated more
51 than once, or multiple addons can be listed, separated by commas.
52 This is used when there is a third-party package that provides
53 debhelper commands. See the PROGRAMMING file for documentation about
54 the sequence addon interface.
56 =item B<--without> I<addon>
58 The inverse of --with, disables using the given addon.
60 =item B<--list>, B<-l>
62 List all available addons.
64 =item B<--until> I<cmd>
66 Run commands in the sequence until and including I<cmd>, then stop.
68 =item B<--before> I<cmd>
70 Run commands in the sequence before I<cmd>, then stop.
72 =item B<--after> I<cmd>
74 Run commands in the sequence that come after I<cmd>.
78 Run all commands in the sequence that have yet to be run.
82 Prints commands that would run for a given sequence, but does not run them.
86 All other options passed to dh are passed on to each command it runs. This
87 can be used to set an option like "-v" or "-X" or "-N", as well as for more
90 In the above options, I<cmd> can be a full name of a debhelper command, or
91 a substring. It'll first search for a command in the sequence exactly
92 matching the name, to avoid any ambiguity. If there are multiple substring
93 matches, the last one in the sequence will be used.
101 foreach my $i (0..$#sequence) {
102 if ($command eq $sequence[$i]) {
108 foreach my $i (0..$#sequence) {
109 if ($sequence[$i] =~ /\Q$command\E/) {
114 error "command specification \"$command\" does not match any command in the sequence"
123 To see what commands are included in a sequence, without actually doing
126 dh binary-arch --no-act
128 This is a very simple rules file, for packages where the default sequences of
129 commands work with no additional options.
135 Often you'll want to pass an option to a specific debhelper command. The
136 easy way to do with is by adding an override target for that command.
145 override_dh_installdocs:
146 dh_installdocs README TODO
148 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
149 what to do for a strange package. Here's how to avoid running either
150 and instead run your own commands.
156 override_dh_auto_configure:
159 override_dh_auto_build:
160 make universe-explode-in-delight
162 Another common case is wanting to do something manually before or
163 after a particular debhelper command is run.
169 override_dh_fixperms:
171 chmod 4755 debian/foo/usr/bin/foo
173 If your package is a python package, dh will use dh_pysupport by
174 default. This is how to use dh_pycentral instead.
178 dh $@ --with python-central
180 Here is how to force use of perl's Module::Build build system,
181 which can be necessary if debhelper wrongly detects that the package
186 dh $@ --buildsystem=perl_build
188 To patch your package using quilt, you can tell dh to use quilt's dh
189 sequence addons like this:
195 Here is an example of overriding where the dh_auto_* commands find
196 the package's source, for a package where the source is located in a
201 dh $@ --sourcedirectory=src
203 And here is an example of how to tell the dh_auto_* commands to build
204 in a subdirectory, which will be removed on clean.
208 dh $@ --builddirectory=build
210 If your package can be built in parallel, you can support parallel building
211 as follows. Then I<dpkg-buildpackage -j> will work.
217 Finally, here is a way to prevent dh from running several commands
218 that you don't want it to run, by defining empty override targets for each
225 # Commands not to run:
226 override_dh_auto_test override_dh_compress override_dh_fixperms:
230 # Stash this away before init modifies it.
233 # python-support is enabled by default, at least for now
234 # (and comes first so python-central loads later and can disable it).
235 unshift @ARGV, "--with=python-support";
238 "until=s" => \$dh{UNTIL},
239 "after=s" => \$dh{AFTER},
240 "before=s" => \$dh{BEFORE},
241 "remaining" => \$dh{REMAINING},
243 my ($option,$value)=@_;
244 push @{$dh{WITH}},split(",", $value);
247 my ($option,$value)=@_;
248 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
251 "list" => \$dh{LIST},
253 # Disable complaints about unknown options; they are passed on the
254 # debhelper commands.
255 ignore_unknown_options => 1,
256 # Bundling does not work well since there are unknown options.
262 # If make is using a jobserver, but it is not available
263 # to this process, clean out MAKEFLAGS. This avoids
264 # ugly warnings when calling make.
265 if (is_make_jobserver_unavailable()) {
266 clean_jobserver_makeflags();
269 # Definitions of sequences.
271 $sequences{build} = [qw{
277 $sequences{clean} = [qw{
282 $sequences{install} = [@{$sequences{build}}, qw{
328 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
329 $sequences{binary} = [@{$sequences{install}}, qw{
334 $sequences{'binary-arch'} = [@{$sequences{binary}}];
336 # Additional command options
339 # sequence addon interface
344 foreach my $sequence (keys %sequences) {
345 my @list=@{$sequences{$sequence}};
346 next unless grep $existing, @list;
348 foreach my $command (@list) {
349 if ($command eq $existing) {
350 push @new, $new if $offset < 0;
352 push @new, $new if $offset > 0;
358 $sequences{$sequence}=\@new;
369 foreach my $sequence (keys %sequences) {
370 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
377 unshift @{$sequences{$sequence}}, $command;
379 sub add_command_options {
381 push @{$command_opts{$command}}, @_;
383 sub remove_command_options {
386 # Remove only specified options
387 if (my $opts = $command_opts{$command}) {
388 foreach my $opt (@_) {
389 $opts = [ grep { $_ ne $opt } @$opts ];
391 $command_opts{$command} = $opts;
395 # Clear all additional options
396 delete $command_opts{$command};
404 eval q{use File::Spec};
405 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
407 for my $module_path (glob "$path/*.pm") {
408 my $name = basename($module_path);
416 for my $name (sort keys %addons) {
423 foreach my $addon (@{$dh{WITH}}) {
424 my $mod="Debian::Debhelper::Sequence::$addon";
428 error("unable to load addon $addon: $@");
432 # Get the sequence of commands to run.
434 error "specify a sequence to run";
437 if ($sequence eq 'debian/rules' ||
438 $sequence =~ /^override_dh_/) {
439 # make -B causes the rules file to be run as a target
440 # and support completly empty override targets
443 elsif (! exists $sequences{$sequence}) {
444 error "Unknown sequence $sequence (choose from: ".
445 join(" ", sort keys %sequences).")";
447 my @sequence=@{$sequences{$sequence}};
449 # The list of all packages that can be acted on.
450 my @packages=@{$dh{DOPACKAGES}};
452 # Get the options to pass to commands in the sequence.
453 # Filter out options intended only for this program.
455 if ($sequence eq 'binary-arch') {
457 # as an optimisation, remove from the list any packages
458 # that are not arch dependent
459 my %arch_packages = map { $_ => 1 } getpackages("arch");
460 @packages = grep { $arch_packages{$_} } @packages;
462 elsif ($sequence eq 'binary-indep') {
464 # ditto optimisation for arch indep
465 my %indep_packages = map { $_ => 1 } getpackages("indep");
466 @packages = grep { $indep_packages{$_} } @packages;
469 my $opt=shift @ARGV_orig;
470 next if $opt eq $sequence;
471 if ($opt =~ /^--?(after|until|before|with|without)$/) {
475 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
479 push @options, "-O".$opt;
482 if ($options[$#options]=~/^-O--/) {
483 $options[$#options].="=".$opt;
486 $options[$#options].=$opt;
491 # Figure out at what point in the sequence to start for each package.
494 foreach my $package (@packages) {
495 my @log=load_log($package, \%logged);
497 # Run commands in the sequence that come after the
499 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
500 # Write a dummy log entry indicating that the specified
501 # command was, in fact, run. This handles the case where
502 # no commands remain to run after it, communicating to
503 # future dh instances that the specified command should not
505 write_log($sequence[$startpoint{$package}-1], $package);
507 elsif ($dh{REMAINING}) {
508 # Start at the beginning so all remaining commands will get
510 $startpoint{$package}=0;
513 # Find the last logged command that is in the sequence, and
514 # continue with the next command after it. If no logged
515 # command is in the sequence, we're starting at the beginning..
516 $startpoint{$package}=0;
517 COMMAND: foreach my $command (reverse @log) {
518 foreach my $i (0..$#sequence) {
519 if ($command eq $sequence[$i]) {
520 $startpoint{$package}=$i+1;
528 # Figure out what point in the sequence to go to.
529 my $stoppoint=$#sequence;
531 $stoppoint=command_pos($dh{UNTIL}, @sequence);
533 elsif ($dh{BEFORE}) {
534 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
537 # Now run the commands in the sequence.
538 foreach my $i (0..$stoppoint) {
539 # Figure out which packages need to run this command.
541 foreach my $package (@packages) {
542 if ($startpoint{$package} > $i ||
543 $logged{$package}{$sequence[$i]}) {
544 push @exclude, $package;
548 if (@exclude eq @packages) {
549 # Command already done for all packages.
553 run($sequence[$i], \@packages, \@exclude, @options);
558 my @packages=@{shift()};
559 my @exclude=@{shift()};
562 # If some packages are excluded, add flags
563 # to prevent them from being acted on.
564 push @options, map { "-N$_" } @exclude;
566 # Check for override targets in debian/rules and
567 # run them instead of running the command directly.
568 my $override_command;
569 my $has_explicit_target = rules_explicit_target("override_".$command);
570 if (defined $has_explicit_target) {
571 $override_command=$command;
572 # Check if target isn't noop
573 if ($has_explicit_target) {
574 # This passes the options through to commands called
576 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
577 $command="debian/rules";
578 @options="override_".$override_command;
585 # Pass additional command options if any
586 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
589 if (defined $command) {
590 # 3 space indent lines the command being run up under the
591 # sequence name after "dh ".
592 print " ".escape_shell($command, @options)."\n";
595 print " ", "# Skipping ", $override_command, " - empty override", "\n";
599 if (defined $command) {
600 my $ret=system($command, @options);
601 if ($ret >> 8 != 0) {
609 if (defined $override_command) {
610 delete $ENV{DH_INTERNAL_OPTIONS};
611 # Need to handle logging for overriden commands here,
612 # because the actual debhelper command may not have
613 # been run by the rules file target.
614 # (But avoid logging for dh_clean since it removes
616 if ($override_command ne 'dh_clean') {
617 my %packages=map { $_ => 1 } @packages;
618 map { delete $packages{$_} } @exclude;
619 write_log($override_command, keys %packages);
629 sub rules_explicit_target {
630 # Checks if a specified target exists as an explicit target
632 # undef is returned if target does not exist, 0 if target is noop
633 # and 1 if target has dependencies or executes commands.
636 if (! $rules_parsed) {
637 my $processing_targets = 0;
638 my $not_a_target = 0;
640 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
642 if ($processing_targets) {
643 if (/^# Not a target:/) {
647 if (!$not_a_target && /^([^#:]+)::?\s*(.*)$/) {
648 # Target is defined. NOTE: if it is a depenency of
649 # .PHONY it will be defined too but that's ok.
650 # $2 contains target dependencies if any.
651 $current_target = $1;
652 $targets{$current_target} = ($2) ? 1 : 0;
655 if (defined $current_target) {
657 # Check if target has commands to execute
658 if (/^#\s*commands to execute/) {
659 $targets{$current_target} = 1;
664 $current_target = undef;
668 # "Not a target:" is always followed by
669 # a target name, so resetting this one
674 elsif (/^# Files$/) {
675 $processing_targets = 1;
682 return $targets{$target};
691 This program is a part of debhelper.
695 Joey Hess <joeyh@debian.org>