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.)
44 dh passes --parallel to dh_auto_* commands if it detects being run by the
45 C<dpkg-buildpackage -jX> command, but a job server of the parent I<make>
46 (presumably debian/rules) is not reachable. Nonetheless, it is highly
47 recommended to pass --parallel/-j option to dh explicitly to indicate that a
48 source package supports parallel building. See L<debhelper(7)/"BUILD SYSTEM
49 OPTIONS"> for more information.
55 =item B<--with> I<addon>[,I<addon>,...]
57 Add the debhelper commands specified by the given addon to appropriate places
58 in the sequence of commands that is run. This option can be repeated more
59 than once, or multiple addons can be listed, separated by commas.
60 This is used when there is a third-party package that provides
61 debhelper commands. See the PROGRAMMING file for documentation about
62 the sequence addon interface.
64 =item B<--without> I<addon>
66 The inverse of --with, disables using the given addon.
68 =item B<--list>, B<-l>
70 List all available addons.
72 =item B<--until> I<cmd>
74 Run commands in the sequence until and including I<cmd>, then stop.
76 =item B<--before> I<cmd>
78 Run commands in the sequence before I<cmd>, then stop.
80 =item B<--after> I<cmd>
82 Run commands in the sequence that come after I<cmd>.
86 Run all commands in the sequence that have yet to be run.
90 All other options passed to dh are passed on to each command it runs. This
91 can be used to set an option like "-v" or "-X" or "-N", as well as for more
94 =head1 COMMAND SPECIFICATION
96 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
97 search for a command in the sequence exactly matching the name, to avoid any
98 ambiguity. If there are multiple substring matches, the last one in the
99 sequence will be used.
107 foreach my $i (0..$#sequence) {
108 if ($command eq $sequence[$i]) {
114 foreach my $i (0..$#sequence) {
115 if ($sequence[$i] =~ /\Q$command\E/) {
120 error "command specification \"$command\" does not match any command in the sequence"
129 To see what commands are included in a sequence, without actually doing
132 dh binary-arch --no-act
134 This is a very simple rules file, for packages where the default sequences of
135 commands work with no additional options.
141 Often you'll want to pass an option to a specific debhelper command. The
142 easy way to do with is by adding an override target for that command.
151 override_dh_installdocs:
152 dh_installdocs README TODO
154 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
155 what to do for a strange package. Here's how to avoid running either
156 and instead run your own commands.
162 override_dh_auto_configure:
165 override_dh_auto_build:
166 make universe-explode-in-delight
168 Another common case is wanting to do something manually before or
169 after a particular debhelper command is run.
175 override_dh_fixperms:
177 chmod 4755 debian/foo/usr/bin/foo
179 If your package is a python package, dh will use dh_pysupport by
180 default. This is how to use dh_pycentral instead.
184 dh --with python-central $@
186 To patch your package using quilt, you can tell dh to use quilt's dh
187 sequence addons like this:
193 Here is an example of overriding where the dh_auto_* commands find
194 the package's source, for a package where the source is located in a
195 subdirectory. It also forces use of perl's Module::Build build system,
196 which can be necessary if debhelper wrongly detects that the package
201 dh --sourcedirectory=src --buildsystem=perl_build $@
205 # Stash this away before init modifies it.
208 # python-support is enabled by default, at least for now
209 # (and comes first so python-central loads later and can disable it).
210 unshift @ARGV, "--with=python-support";
212 # Disable complaints about unknown options for both dh and the commands
213 # it runs. This is done because dh accepts and passes on options that may
214 # be specific to only some debhelper commands.
215 $ENV{DH_IGNORE_UNKNOWN_OPTIONS}=1;
218 "until=s" => \$dh{UNTIL},
219 "after=s" => \$dh{AFTER},
220 "before=s" => \$dh{BEFORE},
221 "remaining" => \$dh{REMAINING},
223 my ($option,$value)=@_;
224 push @{$dh{WITH}},split(",", $value);
227 my ($option,$value)=@_;
228 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
231 "list" => \$dh{LIST},
232 "j:i" => \$dh{PARALLEL},
233 "parallel:i" => \$dh{PARALLEL},
237 # Parallel defaults to "unset" unless unavailable --jobserver-fds is detected
238 # in MAKEFLAGS. This typically means dpkg-buildpackage was called with a -jX
239 # option. Then -jX in MAKEFLAGS gets "consumed" by make invocation of
240 # debian/rules and "converted" to --jobserver-fds. If jobserver is
241 # unavailable, dh was probably called via debian/rules without "+" prefix (so
242 # make has closed jobserver FDs). In such a case, MAKEFLAGS is cleaned from the
243 # offending --jobserver-fds option in order to prevent further make invocations
244 # from spitting warnings and disabling job support.
245 my ($status, $makeflags) = get_make_jobserver_status();
246 if ($status eq "jobserver-unavailable") {
247 # Stop make from spitting pointless job control warnings
248 if (defined $makeflags) {
249 $ENV{MAKEFLAGS} = $makeflags;
252 delete $ENV{MAKEFLAGS};
254 # Enable parallel (no maximum) if the package doesn't since it appears this
255 # dh is called via dpkg-buildpackage -jX.
256 $dh{PARALLEL} = 0 if !defined $dh{PARALLEL};
259 # Definitions of sequences.
261 $sequences{build} = [qw{
267 $sequences{clean} = [qw{
272 $sequences{install} = [@{$sequences{build}}, qw{
318 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
319 $sequences{binary} = [@{$sequences{install}}, qw{
324 $sequences{'binary-arch'} = [@{$sequences{binary}}];
326 # Additional command options
329 # sequence addon interface
334 foreach my $sequence (keys %sequences) {
335 my @list=@{$sequences{$sequence}};
336 next unless grep $existing, @list;
338 foreach my $command (@list) {
339 if ($command eq $existing) {
340 push @new, $new if $offset < 0;
342 push @new, $new if $offset > 0;
348 $sequences{$sequence}=\@new;
359 foreach my $sequence (keys %sequences) {
360 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
367 unshift @{$sequences{$sequence}}, $command;
369 sub add_command_options {
371 push @{$command_opts{$command}}, @_;
373 sub remove_command_options {
376 # Remove only specified options
377 if (my $opts = $command_opts{$command}) {
378 foreach my $opt (@_) {
379 $opts = [ grep { $_ ne $opt } @$opts ];
381 $command_opts{$command} = $opts;
385 # Clear all additional options
386 delete $command_opts{$command};
394 eval q{use File::Spec};
395 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
397 for my $module_path (glob "$path/*.pm") {
398 my $name = basename($module_path);
406 for my $name (sort keys %addons) {
413 foreach my $addon (@{$dh{WITH}}) {
414 my $mod="Debian::Debhelper::Sequence::$addon";
418 error("unable to load addon $addon: $@");
422 # Get the sequence of commands to run.
424 error "specify a sequence to run";
427 if ($sequence eq 'debian/rules' ||
428 $sequence =~ /^override_dh_/) {
429 # make -B causes the rules file to be run as a target
430 # and support completly empty override targets
433 elsif (! exists $sequences{$sequence}) {
434 error "Unknown sequence $sequence (choose from: ".
435 join(" ", sort keys %sequences).")";
437 my @sequence=@{$sequences{$sequence}};
439 # The list of all packages that can be acted on.
440 my @packages=@{$dh{DOPACKAGES}};
442 # Get the options to pass to commands in the sequence.
443 # Filter out options intended only for this program.
445 if ($sequence eq 'binary-arch') {
447 # as an optimisation, remove from the list any packages
448 # that are not arch dependent
449 my %arch_packages = map { $_ => 1 } getpackages("arch");
450 @packages = grep { $arch_packages{$_} } @packages;
452 elsif ($sequence eq 'binary-indep') {
454 # ditto optimisation for arch indep
455 my %indep_packages = map { $_ => 1 } getpackages("indep");
456 @packages = grep { $indep_packages{$_} } @packages;
459 my $opt=shift @ARGV_orig;
460 next if $opt eq $sequence;
461 if ($opt =~ /^--?(after|until|before|with|without)$/) {
465 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without|parallel)=)/) {
468 elsif ($opt =~ /^(-j|--parallel)$/) {
469 # Argument to -j/--parallel is optional.
470 shift @ARGV_orig if @ARGV_orig > 0 && $ARGV_orig[0] =~ /^\d+$/;
476 # Figure out at what point in the sequence to start for each package.
479 foreach my $package (@packages) {
480 my @log=load_log($package, \%logged);
482 # Run commands in the sequence that come after the
484 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
485 # Write a dummy log entry indicating that the specified
486 # command was, in fact, run. This handles the case where
487 # no commands remain to run after it, communicating to
488 # future dh instances that the specified command should not
490 write_log($sequence[$startpoint{$package}-1], $package);
492 elsif ($dh{REMAINING}) {
493 # Start at the beginning so all remaining commands will get
495 $startpoint{$package}=0;
498 # Find the last logged command that is in the sequence, and
499 # continue with the next command after it. If no logged
500 # command is in the sequence, we're starting at the beginning..
501 $startpoint{$package}=0;
502 COMMAND: foreach my $command (reverse @log) {
503 foreach my $i (0..$#sequence) {
504 if ($command eq $sequence[$i]) {
505 $startpoint{$package}=$i+1;
513 # Figure out what point in the sequence to go to.
514 my $stoppoint=$#sequence;
516 $stoppoint=command_pos($dh{UNTIL}, @sequence);
518 elsif ($dh{BEFORE}) {
519 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
522 # Now run the commands in the sequence.
523 foreach my $i (0..$stoppoint) {
524 # Figure out which packages need to run this command.
526 foreach my $package (@packages) {
527 if ($startpoint{$package} > $i ||
528 $logged{$package}{$sequence[$i]}) {
529 push @exclude, $package;
533 if (@exclude eq @packages) {
534 # Command already done for all packages.
538 run($sequence[$i], \@packages, \@exclude, @options);
543 my @packages=@{shift()};
544 my @exclude=@{shift()};
547 # If some packages are excluded, add flags
548 # to prevent them from being acted on.
549 push @options, map { "-N$_" } @exclude;
551 # Pass --parallel to dh_auto_* commands if requested
552 if (defined $dh{PARALLEL} && ($dh{PARALLEL} == 0 || $dh{PARALLEL} > 1)
553 && $command =~ /^dh_auto_/) {
554 push @options, "--parallel" . ($dh{PARALLEL} > 1 ? "=$dh{PARALLEL}" : "");
557 # Check for override targets in debian/rules and
558 # run them instead of running the command directly.
559 my $override_command;
560 if (rules_explicit_target("override_".$command)) {
561 $override_command=$command;
562 # This passes the options through to commands called
564 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
565 $command="debian/rules";
566 @options="override_".$override_command;
569 # Pass additional command options if any
570 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
573 # 3 space indent lines the command being run up under the
574 # sequence name after "dh ".
575 print " ".escape_shell($command, @options)."\n";
578 my $ret=system($command, @options);
579 if ($ret >> 8 != 0) {
586 if (defined $override_command) {
587 delete $ENV{DH_INTERNAL_OPTIONS};
588 # Need to handle logging for overriden commands here,
589 # because the actual debhelper command may not have
590 # been run by the rules file target.
591 # (But avoid logging for dh_clean since it removes
593 if ($override_command ne 'dh_clean') {
594 my %packages=map { $_ => 1 } @packages;
595 map { delete $packages{$_} } @exclude;
596 write_log($override_command, keys %packages);
606 sub rules_explicit_target {
607 # Checks if a specified target exists as an explicit target
611 if (! $rules_parsed) {
612 my $processing_targets = 0;
613 my $not_a_target = 0;
614 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
616 if ($processing_targets) {
617 if (/^# Not a target:/) {
621 if (!$not_a_target && /^([^#:]+)::?/) {
623 # NOTE: if it is a depenency
624 # of .PHONY it will be
625 # defined too but that's ok.
628 # "Not a target:" is always followed by
629 # a target name, so resetting this one
633 } elsif (/^# Files$/) {
634 $processing_targets = 1;
641 return exists $targets{$target};
650 This program is a part of debhelper.
654 Joey Hess <joeyh@debian.org>