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 If debian/rules contains a target with a name like "override_I<dh_command>",
28 then when it would normally run I<dh_command>, dh will instead call that
29 target. The override target can then run the command with additional options,
30 or run entirely different commands instead. See examples below. (Note that to
31 use this feature, you should Build-Depend on debhelper 7.0.50 or above.)
37 =item B<--with> I<addon>[,I<addon>,...]
39 Add the debhelper commands specified by the given addon to appropriate places
40 in the sequence of commands that is run. This option can be repeated more
41 than once, or multiple addons can be listed, separated by commas.
42 This is used when there is a third-party package that provides
43 debhelper commands. See the PROGRAMMING file for documentation about
44 the sequence addon interface.
46 =item B<--without> I<addon>
48 The inverse of --with, disables using the given addon.
50 =item B<--list>, B<-l>
52 List all available addons.
54 =item B<--until> I<cmd>
56 Run commands in the sequence until and including I<cmd>, then stop.
58 =item B<--before> I<cmd>
60 Run commands in the sequence before I<cmd>, then stop.
62 =item B<--after> I<cmd>
64 Run commands in the sequence that come after I<cmd>.
68 Run all commands in the sequence that have yet to be run.
72 Prints commands that would run for a given sequence, but does not run them.
76 All other options passed to dh are passed on to each command it runs. This
77 can be used to set an option like "-v" or "-X" or "-N", as well as for more
80 In the above options, I<cmd> can be a full name of a debhelper command, or
81 a substring. It'll first search for a command in the sequence exactly
82 matching the name, to avoid any ambiguity. If there are multiple substring
83 matches, the last one in the sequence will be used.
91 foreach my $i (0..$#sequence) {
92 if ($command eq $sequence[$i]) {
98 foreach my $i (0..$#sequence) {
99 if ($sequence[$i] =~ /\Q$command\E/) {
104 error "command specification \"$command\" does not match any command in the sequence"
113 To see what commands are included in a sequence, without actually doing
116 dh binary-arch --no-act
118 This is a very simple rules file, for packages where the default sequences of
119 commands work with no additional options.
125 Often you'll want to pass an option to a specific debhelper command. The
126 easy way to do with is by adding an override target for that command.
135 override_dh_installdocs:
136 dh_installdocs README TODO
138 Sometimes the automated L<dh_auto_configure(1)> and L<dh_auto_build(1)>
139 can't guess what to do for a strange package. Here's how to avoid running
140 either and instead run your own commands.
146 override_dh_auto_configure:
149 override_dh_auto_build:
150 make universe-explode-in-delight
152 Another common case is wanting to do something manually before or
153 after a particular debhelper command is run.
159 override_dh_fixperms:
161 chmod 4755 debian/foo/usr/bin/foo
163 If your package is a python package, dh will use dh_pysupport by
164 default. This is how to use dh_pycentral instead.
168 dh $@ --with python-central
170 If your package uses autotools and you want to freshen config.sub and
171 config.guess with newer versions from the autotools-dev package
172 at build time, you can use some commands provided in autotools-dev
173 that automate it, like this.
177 dh $@ --with autotools_dev
179 Here is how to force use of perl's Module::Build build system,
180 which can be necessary if debhelper wrongly detects that the package
185 dh $@ --buildsystem=perl_build
187 To patch your package using quilt, you can tell dh to use quilt's dh
188 sequence addons like this:
194 Here is an example of overriding where the dh_auto_* commands find
195 the package's source, for a package where the source is located in a
200 dh $@ --sourcedirectory=src
202 And here is an example of how to tell the dh_auto_* commands to build
203 in a subdirectory, which will be removed on clean.
207 dh $@ --builddirectory=build
209 If your package can be built in parallel, you can support parallel building
210 as follows. Then I<dpkg-buildpackage -j> will work.
216 Here is a way to prevent dh from running several commands that you don't
217 want it to run, by defining empty override targets for each command.
223 # Commands not to run:
224 override_dh_auto_test override_dh_compress override_dh_fixperms:
226 Sometimes, you may need to make an override target only run commands when a
227 particular package is being built. This can be accomplished using
228 L<dh_listpackages(1)> to test what is being built. For example:
234 override_dh_fixperms:
236 ifneq (,$(findstring foo, $(shell dh_listpackages)))
237 chmod 4755 debian/foo/usr/bin/foo
240 Finally, remember that you are not limited to using override targets in the
241 rules file when using dh. You can also explicitly define any of the regular
242 rules file targets when it makes sense to do so. A common reason to do this
243 is if your package needs different build-arch and build-indep targets. For
244 example, a package with a long document build process can put it in
245 build-indep to avoid build daemons redundantly building the documentation.
251 build: build-arch build-indep ;
259 If you're curious about dh's internals, here's how it works under the hood.
261 Each debhelper command will record when it's successfully run in
262 debian/package.debhelper.log. (Which dh_clean deletes.) So dh can tell
263 which commands have already been run, for which packages, and skip running
264 those commands again.
266 Each time dh is run, it examines the log, and finds the last logged command
267 that is in the specified sequence. It then continues with the next command
268 in the sequence. The B<--until>, B<--before>, B<--after>, and B<--remaining>
269 options can override this behavior.
271 dh uses the DH_INTERNAL_OPTIONS environment variable to pass information
272 through to debhelper commands that are run inside override targets. The
273 contents (and indeed, existence) of this environment variable, as the name
274 might suggest, is subject to change at any time.
278 # Stash this away before init modifies it.
281 # python-support is enabled by default, at least for now
282 # (and comes first so python-central loads later and can disable it).
283 unshift @ARGV, "--with=python-support";
286 "until=s" => \$dh{UNTIL},
287 "after=s" => \$dh{AFTER},
288 "before=s" => \$dh{BEFORE},
289 "remaining" => \$dh{REMAINING},
291 my ($option,$value)=@_;
292 push @{$dh{WITH}},split(",", $value);
295 my ($option,$value)=@_;
296 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
298 "l" => \&list_addons,
299 "list" => \&list_addons,
301 # Disable complaints about unknown options; they are passed on to
302 # the debhelper commands.
303 ignore_unknown_options => 1,
304 # Bundling does not work well since there are unknown options.
310 # If make is using a jobserver, but it is not available
311 # to this process, clean out MAKEFLAGS. This avoids
312 # ugly warnings when calling make.
313 if (is_make_jobserver_unavailable()) {
314 clean_jobserver_makeflags();
317 # Definitions of sequences.
319 $sequences{build} = [qw{
325 $sequences{clean} = [qw{
330 $sequences{install} = [@{$sequences{build}}, qw{
376 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
377 $sequences{binary} = [@{$sequences{install}}, qw{
382 $sequences{'binary-arch'} = [@{$sequences{binary}}];
384 # Additional command options
387 # sequence addon interface
392 foreach my $sequence (keys %sequences) {
393 my @list=@{$sequences{$sequence}};
394 next unless grep $existing, @list;
396 foreach my $command (@list) {
397 if ($command eq $existing) {
398 push @new, $new if $offset < 0;
400 push @new, $new if $offset > 0;
406 $sequences{$sequence}=\@new;
417 foreach my $sequence (keys %sequences) {
418 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
425 unshift @{$sequences{$sequence}}, $command;
427 sub add_command_options {
429 push @{$command_opts{$command}}, @_;
431 sub remove_command_options {
434 # Remove only specified options
435 if (my $opts = $command_opts{$command}) {
436 foreach my $opt (@_) {
437 $opts = [ grep { $_ ne $opt } @$opts ];
439 $command_opts{$command} = $opts;
443 # Clear all additional options
444 delete $command_opts{$command};
452 eval q{use File::Spec};
453 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
455 for my $module_path (glob "$path/*.pm") {
456 my $name = basename($module_path);
464 for my $name (sort keys %addons) {
471 foreach my $addon (@{$dh{WITH}}) {
472 my $mod="Debian::Debhelper::Sequence::$addon";
476 error("unable to load addon $addon: $@");
482 # From v8, the sequence is the very first parameter.
483 $sequence=shift @ARGV_orig;
484 if ($sequence=~/^-/) {
485 error "Unknown sequence $sequence (options should not come before the sequence)";
489 # Before v8, the sequence could be at any position in the parameters,
490 # so was what was left after parsing.
492 if (defined $sequence) {
493 @ARGV_orig=grep { $_ ne $sequence } @ARGV_orig;
496 if (! defined $sequence) {
497 error "specify a sequence to run";
499 if ($sequence eq 'debian/rules' ||
500 $sequence =~ /^override_dh_/) {
501 # make -B causes the rules file to be run as a target.
502 # Also support completly empty override targets.
505 elsif (! exists $sequences{$sequence}) {
506 error "Unknown sequence $sequence (choose from: ".
507 join(" ", sort keys %sequences).")";
509 my @sequence=@{$sequences{$sequence}};
511 # The list of all packages that can be acted on.
512 my @packages=@{$dh{DOPACKAGES}};
514 # Get the options to pass to commands in the sequence.
515 # Filter out options intended only for this program.
517 if ($sequence eq 'binary-arch') {
519 # as an optimisation, remove from the list any packages
520 # that are not arch dependent
521 my %arch_packages = map { $_ => 1 } getpackages("arch");
522 @packages = grep { $arch_packages{$_} } @packages;
524 elsif ($sequence eq 'binary-indep') {
526 # ditto optimisation for arch indep
527 my %indep_packages = map { $_ => 1 } getpackages("indep");
528 @packages = grep { $indep_packages{$_} } @packages;
531 my $opt=shift @ARGV_orig;
532 if ($opt =~ /^--?(after|until|before|with|without)$/) {
536 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
540 push @options, "-O".$opt;
543 if ($options[$#options]=~/^-O--/) {
544 $options[$#options].="=".$opt;
547 $options[$#options].=$opt;
552 # Figure out at what point in the sequence to start for each package.
555 foreach my $package (@packages) {
556 my @log=load_log($package, \%logged);
558 # Run commands in the sequence that come after the
560 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
561 # Write a dummy log entry indicating that the specified
562 # command was, in fact, run. This handles the case where
563 # no commands remain to run after it, communicating to
564 # future dh instances that the specified command should not
566 write_log($sequence[$startpoint{$package}-1], $package);
568 elsif ($dh{REMAINING}) {
569 # Start at the beginning so all remaining commands will get
571 $startpoint{$package}=0;
574 # Find the last logged command that is in the sequence, and
575 # continue with the next command after it. If no logged
576 # command is in the sequence, we're starting at the beginning..
577 $startpoint{$package}=0;
578 COMMAND: foreach my $command (reverse @log) {
579 foreach my $i (0..$#sequence) {
580 if ($command eq $sequence[$i]) {
581 $startpoint{$package}=$i+1;
589 # Figure out what point in the sequence to go to.
590 my $stoppoint=$#sequence;
592 $stoppoint=command_pos($dh{UNTIL}, @sequence);
594 elsif ($dh{BEFORE}) {
595 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
598 # Now run the commands in the sequence.
599 foreach my $i (0..$stoppoint) {
600 # Figure out which packages need to run this command.
602 foreach my $package (@packages) {
603 if ($startpoint{$package} > $i ||
604 $logged{$package}{$sequence[$i]}) {
605 push @exclude, $package;
609 if (@exclude eq @packages) {
610 # Command already done for all packages.
614 run($sequence[$i], \@packages, \@exclude, @options);
619 my @packages=@{shift()};
620 my @exclude=@{shift()};
623 # If some packages are excluded, add flags
624 # to prevent them from being acted on.
625 push @options, map { "-N$_" } @exclude;
627 # Check for override targets in debian/rules and
628 # run them instead of running the command directly.
629 my $override_command;
630 my $has_explicit_target = rules_explicit_target("override_".$command);
631 if (defined $has_explicit_target) {
632 $override_command=$command;
633 # Check if target isn't noop
634 if ($has_explicit_target) {
635 # This passes the options through to commands called
637 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
638 $command="debian/rules";
639 @options="override_".$override_command;
646 # Pass additional command options if any
647 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
650 if (defined $command) {
651 # 3 space indent lines the command being run up under the
652 # sequence name after "dh ".
653 print " ".escape_shell($command, @options)."\n";
656 print " ", "# Skipping ", $override_command, " - empty override", "\n";
660 if (defined $command) {
661 my $ret=system($command, @options);
662 if ($ret >> 8 != 0) {
670 if (defined $override_command) {
671 delete $ENV{DH_INTERNAL_OPTIONS};
672 # Need to handle logging for overriden commands here,
673 # because the actual debhelper command may not have
674 # been run by the rules file target.
675 # (But avoid logging for dh_clean since it removes
677 if ($override_command ne 'dh_clean') {
678 my %packages=map { $_ => 1 } @packages;
679 map { delete $packages{$_} } @exclude;
680 write_log($override_command, keys %packages);
690 sub rules_explicit_target {
691 # Checks if a specified target exists as an explicit target
693 # undef is returned if target does not exist, 0 if target is noop
694 # and 1 if target has dependencies or executes commands.
697 if (! $rules_parsed) {
698 my $processing_targets = 0;
699 my $not_a_target = 0;
701 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
703 if ($processing_targets) {
704 if (/^# Not a target:/) {
708 if (!$not_a_target && /^([^#:]+)::?\s*(.*)$/) {
709 # Target is defined. NOTE: if it is a depenency of
710 # .PHONY it will be defined too but that's ok.
711 # $2 contains target dependencies if any.
712 $current_target = $1;
713 $targets{$current_target} = ($2) ? 1 : 0;
716 if (defined $current_target) {
718 # Check if target has commands to execute
719 if (/^#\s*commands to execute/) {
720 $targets{$current_target} = 1;
725 $current_target = undef;
729 # "Not a target:" is always followed by
730 # a target name, so resetting this one
735 elsif (/^# Files$/) {
736 $processing_targets = 1;
743 return $targets{$target};
752 This program is a part of debhelper.
756 Joey Hess <joeyh@debian.org>