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 Here is an example of overriding where the B<dh_auto_>I<*> commands find
197 the package's source, for a package where the source is located in a
202 dh $@ --sourcedirectory=src
204 And here is an example of how to tell the B<dh_auto_>I<*> commands to build
205 in a subdirectory, which will be removed on B<clean>.
209 dh $@ --builddirectory=build
211 If your package can be built in parallel, you can support parallel building
212 as follows. Then B<dpkg-buildpackage -j> will work.
218 Here is a way to prevent B<dh> from running several commands that you don't
219 want it to run, by defining empty override targets for each command.
225 # Commands not to run:
226 override_dh_auto_test override_dh_compress override_dh_fixperms:
228 Sometimes, you may need to make an override target only run commands when a
229 particular package is being built. This can be accomplished using
230 L<dh_listpackages(1)> to test what is being built. For example:
236 override_dh_fixperms:
238 ifneq (,$(filter foo, $(shell dh_listpackages)))
239 chmod 4755 debian/foo/usr/bin/foo
242 Finally, remember that you are not limited to using override targets in the
243 rules file when using B<dh>. You can also explicitly define any of the regular
244 rules file targets when it makes sense to do so. A common reason to do this
245 is if your package needs different B<build-arch> and B<build-indep> targets. For
246 example, a package with a long document build process can put it in
247 B<build-indep> to avoid build daemons redundantly building the documentation.
253 build: build-arch build-indep ;
261 If you're curious about B<dh>'s internals, here's how it works under the hood.
263 Each debhelper command will record when it's successfully run in
264 F<debian/package.debhelper.log>. (Which B<dh_clean> deletes.) So B<dh> can tell
265 which commands have already been run, for which packages, and skip running
266 those commands again.
268 Each time B<dh> is run, it examines the log, and finds the last logged command
269 that is in the specified sequence. It then continues with the next command
270 in the sequence. The B<--until>, B<--before>, B<--after>, and B<--remaining>
271 options can override this behavior.
273 A sequence can also have dependencies. For example, the "binary"
274 sequence depends upon the "binary-arch" and "binary-indep" sequences,
275 and the "binary-arch" sequence depends upon the "install-arch"
276 sequence which in turn depends upon the "build-arch" sequence. These
277 will, by default, be run via "debian/rules <sequence>" and so may be
278 overridden or extended there, or else will run dh again to execute the
279 depending sequence. For example, "dh binary-arch" will run
280 "debian/rules install-arch" which will run "dh install-arch" unless a
281 custom install-arch target replaces the default target.
283 B<dh> uses the B<DH_INTERNAL_OPTIONS> environment variable to pass information
284 through to debhelper commands that are run inside override targets. The
285 contents (and indeed, existence) of this environment variable, as the name
286 might suggest, is subject to change at any time.
290 # Stash this away before init modifies it.
293 # python-support is enabled by default, at least for now
294 # (and comes first so python-central loads later and can disable it).
295 unshift @ARGV, "--with=python-support";
298 "until=s" => \$dh{UNTIL},
299 "after=s" => \$dh{AFTER},
300 "before=s" => \$dh{BEFORE},
301 "remaining" => \$dh{REMAINING},
303 my ($option,$value)=@_;
304 push @{$dh{WITH}},split(",", $value);
307 my ($option,$value)=@_;
308 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
310 "l" => \&list_addons,
311 "list" => \&list_addons,
313 # Disable complaints about unknown options; they are passed on to
314 # the debhelper commands.
315 ignore_unknown_options => 1,
316 # Bundling does not work well since there are unknown options.
322 # If make is using a jobserver, but it is not available
323 # to this process, clean out MAKEFLAGS. This avoids
324 # ugly warnings when calling make.
325 if (is_make_jobserver_unavailable()) {
326 clean_jobserver_makeflags();
329 # Definitions of sequences.
337 $sequences{build} = [@bd];
338 $sequences{'build-indep'} = [@bd];
339 $sequences{'build-arch'} = [@bd];
340 $sequences{clean} = [qw{
385 $sequences{'install'} = [@i];
386 $sequences{'install-indep'} = [@i];
387 $sequences{'install-arch'} = [@i];
399 $sequences{binary} = [@ba, @b];
400 $sequences{'binary-indep'} = [@b];
401 $sequences{'binary-arch'} = [@ba, @b];
403 # Sequence dependencies
405 $sequence_deps{build} = ['build-arch', 'build-indep'];
406 $sequence_deps{install} = ['install-arch', 'install-indep'];
407 $sequence_deps{'install-arch'} = ['build-arch'];
408 $sequence_deps{'install-indep'} = ['build-indep'];
409 $sequence_deps{binary} = ['binary-arch', 'binary-indep'];
410 $sequence_deps{'binary-arch'} = ['install-arch'];
411 $sequence_deps{'binary-indep'} = ['install-indep'];
413 # Additional command options
416 # sequence addon interface
421 foreach my $sequence (keys %sequences) {
422 my @list=@{$sequences{$sequence}};
423 next unless grep $existing, @list;
425 foreach my $command (@list) {
426 if ($command eq $existing) {
427 push @new, $new if $offset < 0;
429 push @new, $new if $offset > 0;
435 $sequences{$sequence}=\@new;
446 foreach my $sequence (keys %sequences) {
447 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
454 unshift @{$sequences{$sequence}}, $command;
456 sub add_command_options {
458 push @{$command_opts{$command}}, @_;
460 sub remove_command_options {
463 # Remove only specified options
464 if (my $opts = $command_opts{$command}) {
465 foreach my $opt (@_) {
466 $opts = [ grep { $_ ne $opt } @$opts ];
468 $command_opts{$command} = $opts;
472 # Clear all additional options
473 delete $command_opts{$command};
481 eval q{use File::Spec};
482 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
484 for my $module_path (glob "$path/*.pm") {
485 my $name = basename($module_path);
493 for my $name (sort keys %addons) {
500 foreach my $addon (@{$dh{WITH}}) {
501 my $mod="Debian::Debhelper::Sequence::$addon";
505 error("unable to load addon $addon: $@");
511 # From v8, the sequence is the very first parameter.
512 $sequence=shift @ARGV_orig;
513 if ($sequence=~/^-/) {
514 error "Unknown sequence $sequence (options should not come before the sequence)";
518 # Before v8, the sequence could be at any position in the parameters,
519 # so was what was left after parsing.
521 if (defined $sequence) {
522 @ARGV_orig=grep { $_ ne $sequence } @ARGV_orig;
525 if (! defined $sequence) {
526 error "specify a sequence to run";
528 if ($sequence eq 'debian/rules' ||
529 $sequence =~ /^override_dh_/) {
530 # make -B causes the rules file to be run as a target.
531 # Also support completly empty override targets.
534 elsif (! exists $sequences{$sequence}) {
535 error "Unknown sequence $sequence (choose from: ".
536 join(" ", sort keys %sequences).")";
538 my @sequence=@{$sequences{$sequence}};
540 # Recursively invoke sequence dependencies before any further processing.
541 # The dh options are not passed in the environment, to ensure that the
542 # behaviour is the same if invoked directly.
544 $deps = $sequence_deps{$sequence}
545 if (exists($sequence_deps{$sequence}));
546 if (defined($deps)) {
547 foreach my $dep (@$deps) {
548 my $command = 'debian/rules';
549 my @dep_options = ($dep);
550 print " ".escape_shell($command, @dep_options)."\n";
552 my $ret=system($command, @dep_options);
553 if ($ret >> 8 != 0) {
563 # The list of all packages that can be acted on.
564 my @packages=@{$dh{DOPACKAGES}};
566 # Get the options to pass to commands in the sequence.
567 # Filter out options intended only for this program.
569 if ($sequence eq 'build-arch' ||
570 $sequence eq 'install-arch' ||
571 $sequence eq 'binary-arch') {
573 # as an optimisation, remove from the list any packages
574 # that are not arch dependent
575 my %arch_packages = map { $_ => 1 } getpackages("arch");
576 @packages = grep { $arch_packages{$_} } @packages;
578 elsif ($sequence eq 'build-indep' ||
579 $sequence eq 'install-indep' ||
580 $sequence eq 'binary-indep') {
582 # ditto optimisation for arch indep
583 my %indep_packages = map { $_ => 1 } getpackages("indep");
584 @packages = grep { $indep_packages{$_} } @packages;
587 my $opt=shift @ARGV_orig;
588 if ($opt =~ /^--?(after|until|before|with|without)$/) {
592 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
596 push @options, "-O".$opt;
599 if ($options[$#options]=~/^-O--/) {
600 $options[$#options].="=".$opt;
603 $options[$#options].=$opt;
608 # Figure out at what point in the sequence to start for each package.
611 foreach my $package (@packages) {
612 my @log=load_log($package, \%logged);
614 # Run commands in the sequence that come after the
616 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
617 # Write a dummy log entry indicating that the specified
618 # command was, in fact, run. This handles the case where
619 # no commands remain to run after it, communicating to
620 # future dh instances that the specified command should not
622 write_log($sequence[$startpoint{$package}-1], $package);
624 elsif ($dh{REMAINING}) {
625 # Start at the beginning so all remaining commands will get
627 $startpoint{$package}=0;
630 # Find the last logged command that is in the sequence, and
631 # continue with the next command after it. If no logged
632 # command is in the sequence, we're starting at the beginning..
633 $startpoint{$package}=0;
634 COMMAND: foreach my $command (reverse @log) {
635 foreach my $i (0..$#sequence) {
636 if ($command eq $sequence[$i]) {
637 $startpoint{$package}=$i+1;
645 # Figure out what point in the sequence to go to.
646 my $stoppoint=$#sequence;
648 $stoppoint=command_pos($dh{UNTIL}, @sequence);
650 elsif ($dh{BEFORE}) {
651 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
654 # Now run the commands in the sequence.
655 foreach my $i (0..$stoppoint) {
656 # Figure out which packages need to run this command.
658 foreach my $package (@packages) {
659 if ($startpoint{$package} > $i ||
660 $logged{$package}{$sequence[$i]}) {
661 push @exclude, $package;
665 if (@exclude eq @packages) {
666 # Command already done for all packages.
670 run($sequence[$i], \@packages, \@exclude, @options);
675 my @packages=@{shift()};
676 my @exclude=@{shift()};
679 # If some packages are excluded, add flags
680 # to prevent them from being acted on.
681 push @options, map { "-N$_" } @exclude;
683 # Check for override targets in debian/rules and
684 # run them instead of running the command directly.
685 my $override_command;
686 my $has_explicit_target = rules_explicit_target("override_".$command);
687 if (defined $has_explicit_target) {
688 $override_command=$command;
689 # Check if target isn't noop
690 if ($has_explicit_target) {
691 # This passes the options through to commands called
693 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
694 # Prevent commands called inside the target from
696 $ENV{DH_INHIBIT_LOG}=$command;
697 $command="debian/rules";
698 @options="override_".$override_command;
705 # Pass additional command options if any
706 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
709 if (defined $command) {
710 # 3 space indent lines the command being run up under the
711 # sequence name after "dh ".
712 print " ".escape_shell($command, @options)."\n";
715 print " ", "# Skipping ", $override_command, " - empty override", "\n";
719 if (defined $command) {
720 my $ret=system($command, @options);
721 if ($ret >> 8 != 0) {
729 if (defined $override_command) {
730 delete $ENV{DH_INTERNAL_OPTIONS};
731 delete $ENV{DH_INHIBIT_LOG};
732 # Update log for overridden command now that it has
733 # finished successfully.
734 # (But avoid logging for dh_clean since it removes
736 if ($override_command ne 'dh_clean') {
737 my %packages=map { $_ => 1 } @packages;
738 map { delete $packages{$_} } @exclude;
739 write_log($override_command, keys %packages);
749 sub rules_explicit_target {
750 # Checks if a specified target exists as an explicit target
752 # undef is returned if target does not exist, 0 if target is noop
753 # and 1 if target has dependencies or executes commands.
756 if (! $rules_parsed) {
757 my $processing_targets = 0;
758 my $not_a_target = 0;
760 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
762 if ($processing_targets) {
763 if (/^# Not a target:/) {
767 if (!$not_a_target && /^([^#:]+)::?\s*(.*)$/) {
768 # Target is defined. NOTE: if it is a depenency of
769 # .PHONY it will be defined too but that's ok.
770 # $2 contains target dependencies if any.
771 $current_target = $1;
772 $targets{$current_target} = ($2) ? 1 : 0;
775 if (defined $current_target) {
777 # Check if target has commands to execute
778 if (/^#\s*commands to execute/) {
779 $targets{$current_target} = 1;
784 $current_target = undef;
788 # "Not a target:" is always followed by
789 # a target name, so resetting this one
794 elsif (/^# Files$/) {
795 $processing_targets = 1;
802 return $targets{$target};
811 This program is a part of debhelper.
815 Joey Hess <joeyh@debian.org>