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 All other options passed to dh are passed on to each command it runs. This
84 can be used to set an option like "-v" or "-X" or "-N", as well as for more
87 =head1 COMMAND SPECIFICATION
89 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
90 search for a command in the sequence exactly matching the name, to avoid any
91 ambiguity. If there are multiple substring matches, the last one in the
92 sequence will be used.
100 foreach my $i (0..$#sequence) {
101 if ($command eq $sequence[$i]) {
107 foreach my $i (0..$#sequence) {
108 if ($sequence[$i] =~ /\Q$command\E/) {
113 error "command specification \"$command\" does not match any command in the sequence"
122 To see what commands are included in a sequence, without actually doing
125 dh binary-arch --no-act
127 This is a very simple rules file, for packages where the default sequences of
128 commands work with no additional options.
134 Often you'll want to pass an option to a specific debhelper command. The
135 easy way to do with is by adding an override target for that command.
144 override_dh_installdocs:
145 dh_installdocs README TODO
147 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
148 what to do for a strange package. Here's how to avoid running either
149 and instead run your own commands.
155 override_dh_auto_configure:
158 override_dh_auto_build:
159 make universe-explode-in-delight
161 Another common case is wanting to do something manually before or
162 after a particular debhelper command is run.
168 override_dh_fixperms:
170 chmod 4755 debian/foo/usr/bin/foo
172 If your package is a python package, dh will use dh_pysupport by
173 default. This is how to use dh_pycentral instead.
177 dh --with python-central $@
179 To patch your package using quilt, you can tell dh to use quilt's dh
180 sequence addons like this:
186 Here is an example of overriding where the dh_auto_* commands find
187 the package's source, for a package where the source is located in a
188 subdirectory. It also forces use of perl's Module::Build build system,
189 which can be necessary if debhelper wrongly detects that the package
194 dh --sourcedirectory=src --buildsystem=perl_build $@
198 # Stash this away before init modifies it.
201 # python-support is enabled by default, at least for now
202 # (and comes first so python-central loads later and can disable it).
203 unshift @ARGV, "--with=python-support";
205 # Disable complaints about unknown options for both dh and the commands
206 # it runs. This is done because dh accepts and passes on options that may
207 # be specific to only some debhelper commands.
208 $ENV{DH_IGNORE_UNKNOWN_OPTIONS}=1;
211 "until=s" => \$dh{UNTIL},
212 "after=s" => \$dh{AFTER},
213 "before=s" => \$dh{BEFORE},
214 "remaining" => \$dh{REMAINING},
216 my ($option,$value)=@_;
217 push @{$dh{WITH}},split(",", $value);
220 my ($option,$value)=@_;
221 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
224 "list" => \$dh{LIST},
228 # Definitions of sequences.
230 $sequences{build} = [qw{
236 $sequences{clean} = [qw{
241 $sequences{install} = [@{$sequences{build}}, qw{
287 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
288 $sequences{binary} = [@{$sequences{install}}, qw{
293 $sequences{'binary-arch'} = [@{$sequences{binary}}];
295 # Additional command options
298 # sequence addon interface
303 foreach my $sequence (keys %sequences) {
304 my @list=@{$sequences{$sequence}};
305 next unless grep $existing, @list;
307 foreach my $command (@list) {
308 if ($command eq $existing) {
309 push @new, $new if $offset < 0;
311 push @new, $new if $offset > 0;
317 $sequences{$sequence}=\@new;
328 foreach my $sequence (keys %sequences) {
329 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
336 unshift @{$sequences{$sequence}}, $command;
338 sub add_command_options {
340 push @{$command_opts{$command}}, @_;
342 sub remove_command_options {
345 # Remove only specified options
346 if (my $opts = $command_opts{$command}) {
347 foreach my $opt (@_) {
348 $opts = [ grep { $_ ne $opt } @$opts ];
350 $command_opts{$command} = $opts;
354 # Clear all additional options
355 delete $command_opts{$command};
363 eval q{use File::Spec};
364 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Sequence");
366 for my $module_path (glob "$path/*.pm") {
367 my $name = basename($module_path);
375 for my $name (sort keys %addons) {
382 foreach my $addon (@{$dh{WITH}}) {
383 my $mod="Debian::Debhelper::Sequence::$addon";
387 error("unable to load addon $addon: $@");
391 # Get the sequence of commands to run.
393 error "specify a sequence to run";
396 if ($sequence eq 'debian/rules' ||
397 $sequence =~ /^override_dh_/) {
398 # make -B causes the rules file to be run as a target
399 # and support completly empty override targets
402 elsif (! exists $sequences{$sequence}) {
403 error "Unknown sequence $sequence (choose from: ".
404 join(" ", sort keys %sequences).")";
406 my @sequence=@{$sequences{$sequence}};
408 # The list of all packages that can be acted on.
409 my @packages=@{$dh{DOPACKAGES}};
411 # Get the options to pass to commands in the sequence.
412 # Filter out options intended only for this program.
414 if ($sequence eq 'binary-arch') {
416 # as an optimisation, remove from the list any packages
417 # that are not arch dependent
418 my %arch_packages = map { $_ => 1 } getpackages("arch");
419 @packages = grep { $arch_packages{$_} } @packages;
421 elsif ($sequence eq 'binary-indep') {
423 # ditto optimisation for arch indep
424 my %indep_packages = map { $_ => 1 } getpackages("indep");
425 @packages = grep { $indep_packages{$_} } @packages;
428 my $opt=shift @ARGV_orig;
429 next if $opt eq $sequence;
430 if ($opt =~ /^--?(after|until|before|with|without)$/) {
434 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
440 # Figure out at what point in the sequence to start for each package.
443 foreach my $package (@packages) {
444 my @log=load_log($package, \%logged);
446 # Run commands in the sequence that come after the
448 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
449 # Write a dummy log entry indicating that the specified
450 # command was, in fact, run. This handles the case where
451 # no commands remain to run after it, communicating to
452 # future dh instances that the specified command should not
454 write_log($sequence[$startpoint{$package}-1], $package);
456 elsif ($dh{REMAINING}) {
457 # Start at the beginning so all remaining commands will get
459 $startpoint{$package}=0;
462 # Find the last logged command that is in the sequence, and
463 # continue with the next command after it. If no logged
464 # command is in the sequence, we're starting at the beginning..
465 $startpoint{$package}=0;
466 COMMAND: foreach my $command (reverse @log) {
467 foreach my $i (0..$#sequence) {
468 if ($command eq $sequence[$i]) {
469 $startpoint{$package}=$i+1;
477 # Figure out what point in the sequence to go to.
478 my $stoppoint=$#sequence;
480 $stoppoint=command_pos($dh{UNTIL}, @sequence);
482 elsif ($dh{BEFORE}) {
483 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
486 # Now run the commands in the sequence.
487 foreach my $i (0..$stoppoint) {
488 # Figure out which packages need to run this command.
490 foreach my $package (@packages) {
491 if ($startpoint{$package} > $i ||
492 $logged{$package}{$sequence[$i]}) {
493 push @exclude, $package;
497 if (@exclude eq @packages) {
498 # Command already done for all packages.
502 run($sequence[$i], \@packages, \@exclude, @options);
507 my @packages=@{shift()};
508 my @exclude=@{shift()};
511 # If some packages are excluded, add flags
512 # to prevent them from being acted on.
513 push @options, map { "-N$_" } @exclude;
515 # Check for override targets in debian/rules and
516 # run them instead of running the command directly.
517 my $override_command;
518 if (rules_explicit_target("override_".$command)) {
519 $override_command=$command;
520 # This passes the options through to commands called
522 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
523 $command="debian/rules";
524 @options="override_".$override_command;
527 # Pass additional command options if any
528 unshift @options, @{$command_opts{$command}} if exists $command_opts{$command};
531 # 3 space indent lines the command being run up under the
532 # sequence name after "dh ".
533 print " ".escape_shell($command, @options)."\n";
536 my $ret=system($command, @options);
537 if ($ret >> 8 != 0) {
544 if (defined $override_command) {
545 delete $ENV{DH_INTERNAL_OPTIONS};
546 # Need to handle logging for overriden commands here,
547 # because the actual debhelper command may not have
548 # been run by the rules file target.
549 # (But avoid logging for dh_clean since it removes
551 if ($override_command ne 'dh_clean') {
552 my %packages=map { $_ => 1 } @packages;
553 map { delete $packages{$_} } @exclude;
554 write_log($override_command, keys %packages);
564 sub rules_explicit_target {
565 # Checks if a specified target exists as an explicit target
569 if (! $rules_parsed) {
570 my $processing_targets = 0;
571 my $not_a_target = 0;
572 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
574 if ($processing_targets) {
575 if (/^# Not a target:/) {
579 if (!$not_a_target && /^([^#:]+)::?/) {
581 # NOTE: if it is a depenency
582 # of .PHONY it will be
583 # defined too but that's ok.
586 # "Not a target:" is always followed by
587 # a target name, so resetting this one
591 } elsif (/^# Files$/) {
592 $processing_targets = 1;
599 return exists $targets{$target};
608 This program is a part of debhelper.
612 Joey Hess <joeyh@debian.org>