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.)
48 =item B<--with> I<addon>[,I<addon>,...]
50 Add the debhelper commands specified by the given addon to appropriate places
51 in the sequence of commands that is run. This option can be repeated more
52 than once, or multiple addons can be listed, separated by commas.
53 This is used when there is a third-party package that provides
54 debhelper commands. See the PROGRAMMING file for documentation about
55 the sequence addon interface.
57 =item B<--without> I<addon>
59 The inverse of --with, disables using the given addon.
61 =item B<--list>, B<-l>
63 List all available addons.
65 =item B<--until> I<cmd>
67 Run commands in the sequence until and including I<cmd>, then stop.
69 =item B<--before> I<cmd>
71 Run commands in the sequence before I<cmd>, then stop.
73 =item B<--after> I<cmd>
75 Run commands in the sequence that come after I<cmd>.
79 Run all commands in the sequence that have yet to be run.
83 Prints commands that would run for a given sequence, but does not run them.
87 All other options passed to dh are passed on to each command it runs. This
88 can be used to set an option like "-v" or "-X" or "-N", as well as for more
91 =head1 COMMAND SPECIFICATION
93 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
94 search for a command in the sequence exactly matching the name, to avoid any
95 ambiguity. If there are multiple substring matches, the last one in the
96 sequence will be used.
104 foreach my $i (0..$#sequence) {
105 if ($command eq $sequence[$i]) {
111 foreach my $i (0..$#sequence) {
112 if ($sequence[$i] =~ /\Q$command\E/) {
117 error "command specification \"$command\" does not match any command in the sequence"
126 To see what commands are included in a sequence, without actually doing
129 dh binary-arch --no-act
131 This is a very simple rules file, for packages where the default sequences of
132 commands work with no additional options.
138 Often you'll want to pass an option to a specific debhelper command. The
139 easy way to do with is by adding an override target for that command.
148 override_dh_installdocs:
149 dh_installdocs README TODO
151 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
152 what to do for a strange package. Here's how to avoid running either
153 and instead run your own commands.
159 override_dh_auto_configure:
162 override_dh_auto_build:
163 make universe-explode-in-delight
165 Another common case is wanting to do something manually before or
166 after a particular debhelper command is run.
172 override_dh_fixperms:
174 chmod 4755 debian/foo/usr/bin/foo
176 If your package is a python package, dh will use dh_pysupport by
177 default. This is how to use dh_pycentral instead.
181 dh --with python-central $@
183 To patch your package using quilt, you can tell dh to use quilt's dh
184 sequence addons like this:
190 Here is an example of overriding where the dh_auto_* commands find
191 the package's source, for a package where the source is located in a
192 subdirectory. It also forces use of perl's Module::Build build system,
193 which can be necessary if debhelper wrongly detects that the package
198 dh --sourcedirectory=src --buildsystem=perl_build $@
202 # Stash this away before init modifies it.
205 # python-support is enabled by default, at least for now
206 # (and comes first so python-central loads later and can disable it).
207 unshift @ARGV, "--with=python-support";
209 # Disable complaints about unknown options for both dh and the commands
210 # it runs. This is done because dh accepts and passes on options that may
211 # be specific to only some debhelper commands.
212 $ENV{DH_IGNORE_UNKNOWN_OPTIONS}=1;
215 "until=s" => \$dh{UNTIL},
216 "after=s" => \$dh{AFTER},
217 "before=s" => \$dh{BEFORE},
218 "remaining" => \$dh{REMAINING},
220 my ($option,$value)=@_;
221 push @{$dh{WITH}},split(",", $value);
224 my ($option,$value)=@_;
225 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
228 "list" => \$dh{LIST},
232 # If make is using a jobserver, but it is not available
233 # to this process, clean out MAKEFLAGS. This avoids
234 # ugly warnings when calling make.
235 if (is_make_jobserver_unavailable()) {
236 clean_jobserver_makeflags();
239 # Definitions of sequences.
241 $sequences{build} = [qw{
247 $sequences{clean} = [qw{
252 $sequences{install} = [@{$sequences{build}}, qw{
298 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
299 $sequences{binary} = [@{$sequences{install}}, qw{
304 $sequences{'binary-arch'} = [@{$sequences{binary}}];
306 # Additional command options
309 # sequence addon interface
314 foreach my $sequence (keys %sequences) {
315 my @list=@{$sequences{$sequence}};
316 next unless grep $existing, @list;
318 foreach my $command (@list) {
319 if ($command eq $existing) {
320 push @new, $new if $offset < 0;
322 push @new, $new if $offset > 0;
328 $sequences{$sequence}=\@new;
339 foreach my $sequence (keys %sequences) {
340 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
347 unshift @{$sequences{$sequence}}, $command;
349 sub add_command_options {
351 push @{$command_opts{$command}}, @_;
353 sub remove_command_options {
356 # Remove only specified options
357 if (my $opts = $command_opts{$command}) {
358 foreach my $opt (@_) {
359 $opts = [ grep { $_ ne $opt } @$opts ];
361 $command_opts{$command} = $opts;
365 # Clear all additional options
366 delete $command_opts{$command};
374 eval q{use File::Spec};
375 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
377 for my $module_path (glob "$path/*.pm") {
378 my $name = basename($module_path);
386 for my $name (sort keys %addons) {
393 foreach my $addon (@{$dh{WITH}}) {
394 my $mod="Debian::Debhelper::Sequence::$addon";
398 error("unable to load addon $addon: $@");
402 # Get the sequence of commands to run.
404 error "specify a sequence to run";
407 if ($sequence eq 'debian/rules' ||
408 $sequence =~ /^override_dh_/) {
409 # make -B causes the rules file to be run as a target
410 # and support completly empty override targets
413 elsif (! exists $sequences{$sequence}) {
414 error "Unknown sequence $sequence (choose from: ".
415 join(" ", sort keys %sequences).")";
417 my @sequence=@{$sequences{$sequence}};
419 # The list of all packages that can be acted on.
420 my @packages=@{$dh{DOPACKAGES}};
422 # Get the options to pass to commands in the sequence.
423 # Filter out options intended only for this program.
425 if ($sequence eq 'binary-arch') {
427 # as an optimisation, remove from the list any packages
428 # that are not arch dependent
429 my %arch_packages = map { $_ => 1 } getpackages("arch");
430 @packages = grep { $arch_packages{$_} } @packages;
432 elsif ($sequence eq 'binary-indep') {
434 # ditto optimisation for arch indep
435 my %indep_packages = map { $_ => 1 } getpackages("indep");
436 @packages = grep { $indep_packages{$_} } @packages;
439 my $opt=shift @ARGV_orig;
440 next if $opt eq $sequence;
441 if ($opt =~ /^--?(after|until|before|with|without)$/) {
445 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
451 # Figure out at what point in the sequence to start for each package.
454 foreach my $package (@packages) {
455 my @log=load_log($package, \%logged);
457 # Run commands in the sequence that come after the
459 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
460 # Write a dummy log entry indicating that the specified
461 # command was, in fact, run. This handles the case where
462 # no commands remain to run after it, communicating to
463 # future dh instances that the specified command should not
465 write_log($sequence[$startpoint{$package}-1], $package);
467 elsif ($dh{REMAINING}) {
468 # Start at the beginning so all remaining commands will get
470 $startpoint{$package}=0;
473 # Find the last logged command that is in the sequence, and
474 # continue with the next command after it. If no logged
475 # command is in the sequence, we're starting at the beginning..
476 $startpoint{$package}=0;
477 COMMAND: foreach my $command (reverse @log) {
478 foreach my $i (0..$#sequence) {
479 if ($command eq $sequence[$i]) {
480 $startpoint{$package}=$i+1;
488 # Figure out what point in the sequence to go to.
489 my $stoppoint=$#sequence;
491 $stoppoint=command_pos($dh{UNTIL}, @sequence);
493 elsif ($dh{BEFORE}) {
494 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
497 # Now run the commands in the sequence.
498 foreach my $i (0..$stoppoint) {
499 # Figure out which packages need to run this command.
501 foreach my $package (@packages) {
502 if ($startpoint{$package} > $i ||
503 $logged{$package}{$sequence[$i]}) {
504 push @exclude, $package;
508 if (@exclude eq @packages) {
509 # Command already done for all packages.
513 run($sequence[$i], \@packages, \@exclude, @options);
518 my @packages=@{shift()};
519 my @exclude=@{shift()};
522 # If some packages are excluded, add flags
523 # to prevent them from being acted on.
524 push @options, map { "-N$_" } @exclude;
526 # Check for override targets in debian/rules and
527 # run them instead of running the command directly.
528 my $override_command;
529 if (rules_explicit_target("override_".$command)) {
530 $override_command=$command;
531 # This passes the options through to commands called
533 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
534 $command="debian/rules";
535 @options="override_".$override_command;
538 # Pass additional command options if any
539 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
542 # 3 space indent lines the command being run up under the
543 # sequence name after "dh ".
544 print " ".escape_shell($command, @options)."\n";
547 my $ret=system($command, @options);
548 if ($ret >> 8 != 0) {
555 if (defined $override_command) {
556 delete $ENV{DH_INTERNAL_OPTIONS};
557 # Need to handle logging for overriden commands here,
558 # because the actual debhelper command may not have
559 # been run by the rules file target.
560 # (But avoid logging for dh_clean since it removes
562 if ($override_command ne 'dh_clean') {
563 my %packages=map { $_ => 1 } @packages;
564 map { delete $packages{$_} } @exclude;
565 write_log($override_command, keys %packages);
575 sub rules_explicit_target {
576 # Checks if a specified target exists as an explicit target
580 if (! $rules_parsed) {
581 my $processing_targets = 0;
582 my $not_a_target = 0;
583 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
585 if ($processing_targets) {
586 if (/^# Not a target:/) {
590 if (!$not_a_target && /^([^#:]+)::?/) {
592 # NOTE: if it is a depenency
593 # of .PHONY it will be
594 # defined too but that's ok.
597 # "Not a target:" is always followed by
598 # a target name, so resetting this one
602 } elsif (/^# Files$/) {
603 $processing_targets = 1;
610 return exists $targets{$target};
619 This program is a part of debhelper.
623 Joey Hess <joeyh@debian.org>