5 dh - debhelper command sequencer
10 use Debian::Debhelper::Dh_Lib;
14 B<dh> I<sequence> [B<--with> I<addon>[B<,>I<addon> ...]] [B<--list>] [B<--until> I<cmd>] [B<--before> I<cmd>] [B<--after> I<cmd>] [B<--remaining>] [S<I<debhelper options>>]
18 B<dh> runs a sequence of debhelper commands. The supported I<sequence>s
19 correspond to the targets of a F<debian/rules> file: B<build-arch>,
20 B<build-indep>, B<build>, B<clean>, B<install-indep>, B<install-arch>,
21 B<install>, B<binary-arch>, B<binary-indep>, and B<binary>.
23 Commands in the B<build-indep>, B<install-indep> and B<binary-indep>
24 sequences are passed the B<-i> option to ensure they only work on
25 architecture independent packages, and commands in the B<build-arch>,
26 B<install-arch> and B<binary-arch> sequences are passed the B<-a>
27 option to ensure they only work on architecture dependent packages.
29 If F<debian/rules> contains a target with a name like B<override_>I<dh_command>,
30 then when it would normally run I<dh_command>, B<dh> will instead call that
31 target. The override target can then run the command with additional options,
32 or run entirely different commands instead. See examples below. (Note that to
33 use this feature, you should Build-Depend on debhelper 7.0.50 or above.)
39 =item B<--with> I<addon>[B<,>I<addon> ...]
41 Add the debhelper commands specified by the given addon to appropriate places
42 in the sequence of commands that is run. This option can be repeated more
43 than once, or multiple addons can be listed, separated by commas.
44 This is used when there is a third-party package that provides
45 debhelper commands. See the F<PROGRAMMING> file for documentation about
46 the sequence addon interface.
48 =item B<--without> I<addon>
50 The inverse of B<--with>, disables using the given addon.
52 =item B<--list>, B<-l>
54 List all available addons.
56 =item B<--until> I<cmd>
58 Run commands in the sequence until and including I<cmd>, then stop.
60 =item B<--before> I<cmd>
62 Run commands in the sequence before I<cmd>, then stop.
64 =item B<--after> I<cmd>
66 Run commands in the sequence that come after I<cmd>.
70 Run all commands in the sequence that have yet to be run.
74 Prints commands that would run for a given sequence, but does not run them.
78 All other options passed to B<dh> are passed on to each command it runs. This
79 can be used to set an option like B<-v> or B<-X> or B<-N>, as well as for more
82 In the above options, I<cmd> can be a full name of a debhelper command, or
83 a substring. It'll first search for a command in the sequence exactly
84 matching the name, to avoid any ambiguity. If there are multiple substring
85 matches, the last one in the sequence will be used.
93 foreach my $i (0..$#sequence) {
94 if ($command eq $sequence[$i]) {
100 foreach my $i (0..$#sequence) {
101 if ($sequence[$i] =~ /\Q$command\E/) {
106 error "command specification \"$command\" does not match any command in the sequence"
115 To see what commands are included in a sequence, without actually doing
118 dh binary-arch --no-act
120 This is a very simple rules file, for packages where the default sequences of
121 commands work with no additional options.
127 Often you'll want to pass an option to a specific debhelper command. The
128 easy way to do with is by adding an override target for that command.
137 override_dh_installdocs:
138 dh_installdocs README TODO
140 Sometimes the automated L<dh_auto_configure(1)> and L<dh_auto_build(1)>
141 can't guess what to do for a strange package. Here's how to avoid running
142 either and instead run your own commands.
148 override_dh_auto_configure:
151 override_dh_auto_build:
152 make universe-explode-in-delight
154 Another common case is wanting to do something manually before or
155 after a particular debhelper command is run.
161 override_dh_fixperms:
163 chmod 4755 debian/foo/usr/bin/foo
165 If your package is a Python package, B<dh> will use B<dh_pysupport> by
166 default. This is how to use B<dh_pycentral> instead.
170 dh $@ --with python-central
172 If your package uses autotools and you want to freshen F<config.sub> and
173 F<config.guess> with newer versions from the B<autotools-dev> package
174 at build time, you can use some commands provided in B<autotools-dev>
175 that automate it, like this.
179 dh $@ --with autotools_dev
181 Here is how to force use of Perl's B<Module::Build> build system,
182 which can be necessary if debhelper wrongly detects that the package
187 dh $@ --buildsystem=perl_build
189 To patch your package using quilt, you can tell B<dh> to use quilt's B<dh>
190 sequence addons like this:
196 In order to override standard build flags, export appropriate environment
197 variables as documented in the L<dpkg-buildflags(1)> manual page. They will be
198 preferred over directly exported their counterparts (CFLAGS, CXXFLAGS, LDFLAGS
199 etc.). For example, to append -Wall to the standard CFLAGS and CXXFLAGS, use:
202 export DEB_CFLAGS_APPEND = -Wall
203 export DEB_CXXFLAGS_APPEND = -Wall
208 Here is an example of overriding where the B<dh_auto_>I<*> commands find
209 the package's source, for a package where the source is located in a
214 dh $@ --sourcedirectory=src
216 And here is an example of how to tell the B<dh_auto_>I<*> commands to build
217 in a subdirectory, which will be removed on B<clean>.
221 dh $@ --builddirectory=build
223 If your package can be built in parallel, you can support parallel building
224 as follows. Then B<dpkg-buildpackage -j> will work.
230 Here is a way to prevent B<dh> from running several commands that you don't
231 want it to run, by defining empty override targets for each command.
237 # Commands not to run:
238 override_dh_auto_test override_dh_compress override_dh_fixperms:
240 Sometimes, you may need to make an override target only run commands when a
241 particular package is being built. This can be accomplished using
242 L<dh_listpackages(1)> to test what is being built. For example:
248 override_dh_fixperms:
250 ifneq (,$(filter foo, $(shell dh_listpackages)))
251 chmod 4755 debian/foo/usr/bin/foo
254 Finally, remember that you are not limited to using override targets in the
255 rules file when using B<dh>. You can also explicitly define any of the regular
256 rules file targets when it makes sense to do so. A common reason to do this
257 is when your package needs different B<build-arch> and B<build-indep> targets.
258 For example, a package with a long document build process can put it in
270 Note that in the example above, dh will arrange for "debian/rules build"
271 to call your build-indep and build-arch targets. You do not need to
272 explicitly define the dependencies in the rules file when using dh with
273 compatability level v9. This example would be more complicated with
274 earlier compatability levels.
278 If you're curious about B<dh>'s internals, here's how it works under the hood.
280 Each debhelper command will record when it's successfully run in
281 F<debian/package.debhelper.log>. (Which B<dh_clean> deletes.) So B<dh> can tell
282 which commands have already been run, for which packages, and skip running
283 those commands again.
285 Each time B<dh> is run, it examines the log, and finds the last logged command
286 that is in the specified sequence. It then continues with the next command
287 in the sequence. The B<--until>, B<--before>, B<--after>, and B<--remaining>
288 options can override this behavior.
290 A sequence can also run dependent targets in debian/rules. For
291 example, the "binary" sequence runs the "install" target.
293 B<dh> sets environment variables listed by B<dpkg-buildflags>, unless
294 they are already set. It supports DEB_BUILD_OPTIONS=noopt too.
296 B<dh> uses the B<DH_INTERNAL_OPTIONS> environment variable to pass information
297 through to debhelper commands that are run inside override targets. The
298 contents (and indeed, existence) of this environment variable, as the name
299 might suggest, is subject to change at any time.
303 # Stash this away before init modifies it.
306 # python-support is enabled by default, at least for now
307 # (and comes first so python-central loads later and can disable it).
308 unshift @ARGV, "--with=python-support";
311 "until=s" => \$dh{UNTIL},
312 "after=s" => \$dh{AFTER},
313 "before=s" => \$dh{BEFORE},
314 "remaining" => \$dh{REMAINING},
316 my ($option,$value)=@_;
317 push @{$dh{WITH}},split(",", $value);
320 my ($option,$value)=@_;
321 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
323 "l" => \&list_addons,
324 "list" => \&list_addons,
326 # Disable complaints about unknown options; they are passed on to
327 # the debhelper commands.
328 ignore_unknown_options => 1,
329 # Bundling does not work well since there are unknown options.
335 # If make is using a jobserver, but it is not available
336 # to this process, clean out MAKEFLAGS. This avoids
337 # ugly warnings when calling make.
338 if (is_make_jobserver_unavailable()) {
339 clean_jobserver_makeflags();
342 # Process the sequence parameter.
345 # From v8, the sequence is the very first parameter.
346 $sequence=shift @ARGV_orig;
347 if ($sequence=~/^-/) {
348 error "Unknown sequence $sequence (options should not come before the sequence)";
352 # Before v8, the sequence could be at any position in the parameters,
353 # so was what was left after parsing.
355 if (defined $sequence) {
356 @ARGV_orig=grep { $_ ne $sequence } @ARGV_orig;
359 if (! defined $sequence) {
360 error "specify a sequence to run";
362 # make -B causes the rules file to be run as a target.
363 # Also support completly empty override targets.
364 # Note: it's not safe to use rules_explicit_target before this check,
365 # since it causes dh to be run.
366 my $dummy_target="debhelper-fail-me";
367 if ($sequence eq 'debian/rules' ||
368 $sequence =~ /^override_dh_/ ||
369 $sequence eq $dummy_target) {
374 # Definitions of sequences.
441 $sequences{clean} = [qw{
446 $sequences{'build-indep'} = [@bd];
447 $sequences{'build-arch'} = [@bd];
449 # From v9, sequences take standard rules targets into account.
450 if (rules_explicit_target('build-arch') ||
451 rules_explicit_target('build-indep')) {
452 # run sequences separately
453 $sequences{build} = [@bd_minimal, rules("build-arch"), rules("build-indep")];
456 # run standard sequence (this is faster)
457 $sequences{build} = [@bd];
459 $sequences{'install-indep'} = [rules("build-indep"), @i];
460 $sequences{'install-arch'} = [rules("build-arch"), @i];
461 if (rules_explicit_target('install-arch') ||
462 rules_explicit_target('install-indep')) {
463 # run sequences separately
464 $sequences{'install'} = [rules("build"), @i_minimal, rules("install-arch"), rules("install-indep")];
467 # run standard sequence (this is faster)
468 $sequences{'install'} = [rules("build"), @i, rules("install-arch"), rules("install-indep")];
470 $sequences{'binary-indep'} = [rules("install-indep"), @b];
471 $sequences{'binary-arch'} = [rules("install-arch"), @ba, @b];
472 $sequences{binary} = [rules("install"), rules("binary-arch"), rules("binary-indep")];
475 $sequences{build} = [@bd];
476 $sequences{'install'} = [@{$sequences{build}}, @i];
477 $sequences{'install-indep'} = [@{$sequences{'build-indep'}}, @i];
478 $sequences{'install-arch'} = [@{$sequences{'build-arch'}}, @i];
479 $sequences{binary} = [@{$sequences{install}}, @ba, @b];
480 $sequences{'binary-indep'} = [@{$sequences{'install-indep'}}, @b];
481 $sequences{'binary-arch'} = [@{$sequences{'install-arch'}}, @ba, @b];
484 # Additional command options
487 # sequence addon interface
492 foreach my $sequence (keys %sequences) {
493 my @list=@{$sequences{$sequence}};
494 next unless grep $existing, @list;
496 foreach my $command (@list) {
497 if ($command eq $existing) {
498 push @new, $new if $offset < 0;
500 push @new, $new if $offset > 0;
506 $sequences{$sequence}=\@new;
517 foreach my $sequence (keys %sequences) {
518 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
525 unshift @{$sequences{$sequence}}, $command;
527 sub add_command_options {
529 push @{$command_opts{$command}}, @_;
531 sub remove_command_options {
534 # Remove only specified options
535 if (my $opts = $command_opts{$command}) {
536 foreach my $opt (@_) {
537 $opts = [ grep { $_ ne $opt } @$opts ];
539 $command_opts{$command} = $opts;
543 # Clear all additional options
544 delete $command_opts{$command};
552 eval q{use File::Spec};
553 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
555 for my $module_path (glob "$path/*.pm") {
556 my $name = basename($module_path);
564 for my $name (sort keys %addons) {
571 # Load addons, which can modify sequences.
572 foreach my $addon (@{$dh{WITH}}) {
573 my $mod="Debian::Debhelper::Sequence::$addon";
577 error("unable to load addon $addon: $@");
581 if (! exists $sequences{$sequence}) {
582 error "Unknown sequence $sequence (choose from: ".
583 join(" ", sort keys %sequences).")";
585 my @sequence=optimize_sequence(@{$sequences{$sequence}});
587 # The list of all packages that can be acted on.
588 my @packages=@{$dh{DOPACKAGES}};
590 # Get the options to pass to commands in the sequence.
591 # Filter out options intended only for this program.
593 if ($sequence eq 'build-arch' ||
594 $sequence eq 'install-arch' ||
595 $sequence eq 'binary-arch') {
597 # as an optimisation, remove from the list any packages
598 # that are not arch dependent
599 my %arch_packages = map { $_ => 1 } getpackages("arch");
600 @packages = grep { $arch_packages{$_} } @packages;
602 elsif ($sequence eq 'build-indep' ||
603 $sequence eq 'install-indep' ||
604 $sequence eq 'binary-indep') {
606 # ditto optimisation for arch indep
607 my %indep_packages = map { $_ => 1 } getpackages("indep");
608 @packages = grep { $indep_packages{$_} } @packages;
611 my $opt=shift @ARGV_orig;
612 if ($opt =~ /^--?(after|until|before|with|without)$/) {
616 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
620 push @options, "-O".$opt;
623 if ($options[$#options]=~/^-O--/) {
624 $options[$#options].="=".$opt;
627 $options[$#options].=$opt;
632 # Figure out at what point in the sequence to start for each package.
635 foreach my $package (@packages) {
636 my @log=load_log($package, \%logged);
638 # Run commands in the sequence that come after the
640 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
641 # Write a dummy log entry indicating that the specified
642 # command was, in fact, run. This handles the case where
643 # no commands remain to run after it, communicating to
644 # future dh instances that the specified command should not
646 write_log($sequence[$startpoint{$package}-1], $package);
648 elsif ($dh{REMAINING}) {
649 # Start at the beginning so all remaining commands will get
651 $startpoint{$package}=0;
654 # Find the last logged command that is in the sequence, and
655 # continue with the next command after it. If no logged
656 # command is in the sequence, we're starting at the beginning..
657 $startpoint{$package}=0;
658 COMMAND: foreach my $command (reverse @log) {
659 foreach my $i (0..$#sequence) {
660 if ($command eq $sequence[$i]) {
661 $startpoint{$package}=$i+1;
669 # Figure out what point in the sequence to go to.
670 my $stoppoint=$#sequence;
672 $stoppoint=command_pos($dh{UNTIL}, @sequence);
674 elsif ($dh{BEFORE}) {
675 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
678 # Now run the commands in the sequence.
679 foreach my $i (0..$stoppoint) {
680 # Figure out which packages need to run this command.
682 foreach my $package (@packages) {
683 if ($startpoint{$package} > $i ||
684 $logged{$package}{$sequence[$i]}) {
685 push @exclude, $package;
689 if (@exclude eq @packages) {
690 # Command already done for all packages.
694 run($sequence[$i], \@packages, \@exclude, @options);
699 my @packages=@{shift()};
700 my @exclude=@{shift()};
703 # If some packages are excluded, add flags
704 # to prevent them from being acted on.
705 push @options, map { "-N$_" } @exclude;
707 # Check for override targets in debian/rules and
708 # run them instead of running the command directly.
709 my $override_command;
710 my $has_explicit_target = rules_explicit_target("override_".$command);
712 my $rules_target = rules_target($command);
713 if (defined $rules_target) {
714 # Don't pass DH_ environment variables, since this is
715 # a fresh invocation of debian/rules and any sub-dh
717 $override_command=$command;
718 delete $ENV{DH_INTERNAL_OPTIONS};
719 delete $ENV{DH_INTERNAL_OVERRIDE};
720 $command="debian/rules";
721 @options=$rules_target;
723 elsif (defined $has_explicit_target) {
724 $override_command=$command;
725 # Check if target isn't noop
726 if ($has_explicit_target) {
727 # This passes the options through to commands called
729 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
730 $ENV{DH_INTERNAL_OVERRIDE}=$command;
731 $command="debian/rules";
732 @options="override_".$override_command;
739 # Pass additional command options if any
740 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
743 if (defined $command) {
744 # 3 space indent lines the command being run up under the
745 # sequence name after "dh ".
746 print " ".escape_shell($command, @options)."\n";
749 print " ", "# Skipping ", $override_command, " - empty override", "\n";
753 if (defined $command) {
754 my $ret=system($command, @options);
756 if ($ret >> 8 != 0) {
764 if (defined $override_command) {
765 # Update log for overridden command now that it has
766 # finished successfully.
767 # (But avoid logging for dh_clean since it removes
769 if ($override_command ne 'dh_clean') {
770 my %packages=map { $_ => 1 } @packages;
771 map { delete $packages{$_} } @exclude;
772 write_log($override_command, keys %packages);
773 commit_override_log(keys %packages);
776 delete $ENV{DH_INTERNAL_OPTIONS};
777 delete $ENV{DH_INTERNAL_OVERRIDE};
782 sub optimize_sequence {
786 # commands can appear multiple times when sequences are
787 # inlined together; only the first should be needed
789 if (! $seen{$command}) {
791 push @sequence, $command;
794 foreach my $command (@_) {
795 my $rules_target=rules_target($command);
796 if (defined $rules_target &&
797 ! defined rules_explicit_target($rules_target)) {
798 # inline the sequence for this implicit target
799 $add->($_) foreach optimize_sequence(@{$sequences{$rules_target}});
810 if ($command =~ /^debian\/rules\s+(.*)/) {
819 return "debian/rules ".join(" ", @_);
826 sub rules_explicit_target {
827 # Checks if a specified target exists as an explicit target
829 # undef is returned if target does not exist, 0 if target is noop
830 # and 1 if target has dependencies or executes commands.
833 if (! $rules_parsed) {
834 my $processing_targets = 0;
835 my $not_a_target = 0;
837 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules $dummy_target 2>/dev/null |");
839 if ($processing_targets) {
840 if (/^# Not a target:/) {
844 if (!$not_a_target && /^([^#:]+)::?\s*(.*)$/) {
845 # Target is defined. NOTE: if it is a depenency of
846 # .PHONY it will be defined too but that's ok.
847 # $2 contains target dependencies if any.
848 $current_target = $1;
849 $targets{$current_target} = ($2) ? 1 : 0;
852 if (defined $current_target) {
854 # Check if target has commands to execute
855 if (/^#\s*commands to execute/) {
856 $targets{$current_target} = 1;
861 $current_target = undef;
865 # "Not a target:" is always followed by
866 # a target name, so resetting this one
871 elsif (/^# Files$/) {
872 $processing_targets = 1;
879 return $targets{$target};
888 This program is a part of debhelper.
892 Joey Hess <joeyh@debian.org>