5 dh - debhelper command sequencer
10 use Debian::Debhelper::Dh_Lib;
14 B<dh> sequence [B<--with> I<addon>[,I<addon>,...]] [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<--until> I<cmd>
63 Run commands in the sequence until and including I<cmd>, then stop.
65 =item B<--before> I<cmd>
67 Run commands in the sequence before I<cmd>, then stop.
69 =item B<--after> I<cmd>
71 Run commands in the sequence that come after I<cmd>.
75 Run all commands in the sequence that have yet to be run.
79 All other options passed to dh are passed on to each command it runs. This
80 can be used to set an option like "-v" or "-X" or "-N", as well as for more
83 =head1 COMMAND SPECIFICATION
85 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
86 search for a command in the sequence exactly matching the name, to avoid any
87 ambiguity. If there are multiple substring matches, the last one in the
88 sequence will be used.
96 foreach my $i (0..$#sequence) {
97 if ($command eq $sequence[$i]) {
103 foreach my $i (0..$#sequence) {
104 if ($sequence[$i] =~ /\Q$command\E/) {
109 error "command specification \"$command\" does not match any command in the sequence"
118 To see what commands are included in a sequence, without actually doing
121 dh binary-arch --no-act
123 This is a very simple rules file, for packages where the default sequences of
124 commands work with no additional options.
130 Often you'll want to pass an option to a specific debhelper command. The
131 easy way to do with is by adding an override target for that command.
140 override_dh_installdocs:
141 dh_installdocs README TODO
143 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
144 what to do for a strange package. Here's how to avoid running either
145 and instead run your own commands.
151 override_dh_auto_configure:
154 override_dh_auto_build:
155 make universe-explode-in-delight
157 Another common case is wanting to do something manually before or
158 after a particular debhelper command is run.
164 override_dh_fixperms:
166 chmod 4755 debian/foo/usr/bin/foo
168 If your package is a python package, dh will use dh_pysupport by
169 default. This is how to use dh_pycentral instead.
173 dh --with python-central $@
175 To patch your package using quilt, you can tell dh to use quilt's dh
176 sequence addons like this:
182 Here is an example of overriding where the dh_auto_* commands find
183 the package's source, for a package where the source is located in a
184 subdirectory. It also forces use of perl's Module::Build build system,
185 which can be necessary if debhelper wrongly detects that the package
190 dh --sourcedirectory=src --buildsystem=perl_build $@
194 # Stash this away before init modifies it.
197 # python-support is enabled by default, at least for now
198 # (and comes first so python-central loads later and can disable it).
199 unshift @ARGV, "--with=python-support";
201 # Disable complaints about unknown options for both dh and the commands
202 # it runs. This is done because dh accepts and passes on options that may
203 # be specific to only some debhelper commands.
204 $ENV{DH_IGNORE_UNKNOWN_OPTIONS}=1;
207 "until=s" => \$dh{UNTIL},
208 "after=s" => \$dh{AFTER},
209 "before=s" => \$dh{BEFORE},
210 "remaining" => \$dh{REMAINING},
212 my ($option,$value)=@_;
213 push @{$dh{WITH}},split(",", $value);
216 my ($option,$value)=@_;
217 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
222 # Definitions of sequences.
224 $sequences{build} = [qw{
230 $sequences{clean} = [qw{
235 $sequences{install} = [@{$sequences{build}}, qw{
282 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
283 $sequences{binary} = [@{$sequences{install}}, qw{
288 $sequences{'binary-arch'} = [@{$sequences{binary}}];
290 # sequence addon interface
295 foreach my $sequence (keys %sequences) {
296 my @list=@{$sequences{$sequence}};
297 next unless grep $existing, @list;
299 foreach my $command (@list) {
300 if ($command eq $existing) {
301 push @new, $new if $offset < 0;
303 push @new, $new if $offset > 0;
309 $sequences{$sequence}=\@new;
320 foreach my $sequence (keys %sequences) {
321 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
328 unshift @{$sequences{$sequence}}, $command;
330 foreach my $addon (@{$dh{WITH}}) {
331 my $mod="Debian::Debhelper::Sequence::$addon";
335 error("--with $addon not supported or failed to load module $mod");
339 # Get the sequence of commands to run.
341 error "specify a sequence to run";
344 if ($sequence eq 'debian/rules' ||
345 $sequence =~ /^override_dh_/) {
346 # make -B causes the rules file to be run as a target
347 # and support completly empty override targets
350 elsif (! exists $sequences{$sequence}) {
351 error "Unknown sequence $sequence (choose from: ".
352 join(" ", sort keys %sequences).")";
354 my @sequence=@{$sequences{$sequence}};
356 # The list of all packages that can be acted on.
357 my @packages=@{$dh{DOPACKAGES}};
359 # Get the options to pass to commands in the sequence.
360 # Filter out options intended only for this program.
362 if ($sequence eq 'binary-arch') {
364 # as an optimisation, remove from the list any packages
365 # that are not arch dependent
366 my %arch_packages = map { $_ => 1 } getpackages("arch");
367 @packages = grep { $arch_packages{$_} } @packages;
369 elsif ($sequence eq 'binary-indep') {
371 # ditto optimisation for arch indep
372 my %indep_packages = map { $_ => 1 } getpackages("indep");
373 @packages = grep { $indep_packages{$_} } @packages;
376 my $opt=shift @ARGV_orig;
377 next if $opt eq $sequence;
378 if ($opt =~ /^--?(after|until|before|with|without)$/) {
382 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
388 # Figure out at what point in the sequence to start for each package.
391 foreach my $package (@packages) {
392 my @log=load_log($package, \%logged);
394 # Run commands in the sequence that come after the
396 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
397 # Write a dummy log entry indicating that the specified
398 # command was, in fact, run. This handles the case where
399 # no commands remain to run after it, communicating to
400 # future dh instances that the specified command should not
402 write_log($sequence[$startpoint{$package}-1], $package);
404 elsif ($dh{REMAINING}) {
405 # Start at the beginning so all remaining commands will get
407 $startpoint{$package}=0;
410 # Find the last logged command that is in the sequence, and
411 # continue with the next command after it. If no logged
412 # command is in the sequence, we're starting at the beginning..
413 $startpoint{$package}=0;
414 COMMAND: foreach my $command (reverse @log) {
415 foreach my $i (0..$#sequence) {
416 if ($command eq $sequence[$i]) {
417 $startpoint{$package}=$i+1;
425 # Figure out what point in the sequence to go to.
426 my $stoppoint=$#sequence;
428 $stoppoint=command_pos($dh{UNTIL}, @sequence);
430 elsif ($dh{BEFORE}) {
431 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
434 # Now run the commands in the sequence.
435 foreach my $i (0..$stoppoint) {
436 # Figure out which packages need to run this command.
438 foreach my $package (@packages) {
439 if ($startpoint{$package} > $i ||
440 $logged{$package}{$sequence[$i]}) {
441 push @exclude, $package;
445 if (@exclude eq @packages) {
446 # Command already done for all packages.
450 run($sequence[$i], \@packages, \@exclude, @options);
455 my @packages=@{shift()};
456 my @exclude=@{shift()};
459 # If some packages are excluded, add flags
460 # to prevent them from being acted on.
461 push @options, map { "-N$_" } @exclude;
463 # Check for override targets in debian/rules and
464 # run them instead of running the command directly.
465 my $override_command;
466 if (rules_explicit_target("override_".$command)) {
467 $override_command=$command;
468 # This passes the options through to commands called
470 $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options);
471 $command="debian/rules";
472 @options="override_".$override_command;
475 # 3 space indent lines the command being run up under the
476 # sequence name after "dh ".
477 print " ".escape_shell($command, @options)."\n";
480 my $ret=system($command, @options);
481 if ($ret >> 8 != 0) {
488 if (defined $override_command) {
489 delete $ENV{DH_INTERNAL_OPTIONS};
490 # Need to handle logging for overriden commands here,
491 # because the actual debhelper command may not have
492 # been run by the rules file target.
493 # (But avoid logging for dh_clean since it removes
495 if ($override_command ne 'dh_clean') {
496 my %packages=map { $_ => 1 } @packages;
497 map { delete $packages{$_} } @exclude;
498 write_log($override_command, keys %packages);
508 sub rules_explicit_target {
509 # Checks if a specified target exists as an explicit target
513 if (! $rules_parsed) {
514 my $processing_targets = 0;
515 my $not_a_target = 0;
516 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
518 if ($processing_targets) {
519 if (/^# Not a target:/) {
523 if (!$not_a_target && /^([^#:]+)::?/) {
525 # NOTE: if it is a depenency
526 # of .PHONY it will be
527 # defined too but that's ok.
530 # "Not a target:" is always followed by
531 # a target name, so resetting this one
535 } elsif (/^# Files$/) {
536 $processing_targets = 1;
543 return exists $targets{$target};
552 This program is a part of debhelper.
556 Joey Hess <joeyh@debian.org>