5 dh - debhelper command sequencer
10 use Debian::Debhelper::Dh_Lib;
14 B<dh> sequence [B<--with> 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.2 or above.)
48 =item B<--with> 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, and is used when there is a third-party package that provides
53 debhelper commands. See "SEQUENCE ADDONS" below for documentation about what
54 such packages should do to be supported by --with.
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 All other options passed to dh are passed on to each command it runs. This
75 can be used to set an option like "-v" or "-X" or "-N", as well as for more
78 =head1 COMMAND SPECIFICATION
80 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
81 search for a command in the sequence exactly matching the name, to avoid any
82 ambiguity. If there are multiple substring matches, the last one in the
83 sequence will be used.
85 =head1 SEQUENCE ADDONS
87 When B<--with> I<addon> is used, dh loads the perl module
88 Debian::Debhelper::Sequence::I<addon>. Two functions are provided to let
89 the module add its commands to sequences:
93 =item Debian::Debhelper::Dh_Lib::insert_before(existing_command, new_command)
95 Insert I<new_command> in sequences before I<existing_command>.
97 =item Debian::Debhelper::Dh_Lib::insert_after(existing_command, new_command)
99 Insert I<new_command> in sequences after I<existing_command>.
101 =item Debian::Debhelper::Dh_Lib::remove_command(existing_command)
103 Remove I<existing_command> from the list of commands to run.
113 foreach my $i (0..$#sequence) {
114 if ($command eq $sequence[$i]) {
120 foreach my $i (0..$#sequence) {
121 if ($sequence[$i] =~ /\Q$command\E/) {
126 error "command specification \"$command\" does not match any command in the sequence"
135 To see what commands are included in a sequence, without actually doing
138 dh binary-arch --no-act
140 This is a very simple rules file, for packages where the default sequences of
141 commands work with no additional options.
147 Often you'll want to pass an option to a specific debhelper command. The
148 easy way to do with is by adding an override target for that command.
157 override_dh_installdocs:
158 dh_installdocs README TODO
160 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
161 what to do for a strange package. Here's how to avoid running either
162 and instead run your own commands.
168 override_dh_auto_configure:
171 override_dh_auto_build:
172 make universe-explode-in-delight
174 Another common case is wanting to do something manually before or
175 after a particular debhelper command is run.
181 override_dh_fixperms:
183 chmod 4755 debian/foo/usr/bin/foo
187 # Stash this away before init modifies it.
191 "until=s" => \$dh{UNTIL},
192 "after=s" => \$dh{AFTER},
193 "before=s" => \$dh{BEFORE},
194 "remaining" => \$dh{REMAINING},
196 my ($option,$value)=@_;
197 push @{$dh{WITH}},$value;
202 # Definitions of sequences.
204 $sequences{build} = [qw{
210 $sequences{clean} = [qw{
215 $sequences{install} = [@{$sequences{build}}, qw{
263 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
264 $sequences{binary} = [@{$sequences{install}}, qw{
269 $sequences{'binary-arch'} = [@{$sequences{binary}}];
271 # --with python-support is enabled by default, at least for now
272 unshift @{$dh{WITH}}, "python-support";
274 # sequence addon interface
279 foreach my $sequence (keys %sequences) {
280 my @list=@{$sequences{$sequence}};
281 next unless grep $existing, @list;
283 foreach my $command (@list) {
284 if ($command eq $existing) {
285 push @new, $new if $offset < 0;
287 push @new, $new if $offset > 0;
293 $sequences{$sequence}=\@new;
304 foreach my $sequence (keys %sequences) {
305 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
309 foreach my $addon (@{$dh{WITH}}) {
310 my $mod="Debian::Debhelper::Sequence::$addon";
314 error("--with $addon not supported or failed to load module $mod");
318 # Get the sequence of commands to run.
320 error "specify a sequence to run";
323 if (! exists $sequences{$sequence}) {
324 error "Unknown sequence $sequence (choose from: ".
325 join(" ", sort keys %sequences).")";
327 my @sequence=@{$sequences{$sequence}};
329 # The list of all packages that can be acted on.
330 my @packages=@{$dh{DOPACKAGES}};
332 # Get the options to pass to commands in the sequence.
333 # Filter out options intended only for this program.
335 if ($sequence eq 'binary-arch') {
337 # as an optimisation, remove from the list any packages
338 # that are not arch dependent
339 my %arch_packages = map { $_ => 1 } getpackages("arch");
340 @packages = grep { $arch_packages{$_} } @packages;
342 elsif ($sequence eq 'binary-indep') {
344 # ditto optimisation for arch indep
345 my %indep_packages = map { $_ => 1 } getpackages("indep");
346 @packages = grep { $indep_packages{$_} } @packages;
349 my $opt=shift @ARGV_orig;
350 next if $opt eq $sequence;
351 if ($opt =~ /^--?(after|until|before|with)$/) {
355 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with)=)/) {
361 # Figure out at what point in the sequence to start for each package.
364 foreach my $package (@packages) {
365 my @log=loadlog($package);
367 # Run commands in the sequence that come after the
369 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
370 # Write a dummy log entry indicating that the specified
371 # command was, in fact, run. This handles the case where
372 # no commands remain to run after it, communicating to
373 # future dh instances that the specified command should not
375 writelog($package, $sequence[$startpoint{$package}-1]);
377 elsif ($dh{REMAINING}) {
378 # Start at the beginning so all remaining commands will get
380 $startpoint{$package}=0;
383 # Find the last logged command that is in the sequence, and
384 # continue with the next command after it. If no logged
385 # command is in the sequence, we're starting at the beginning..
386 $startpoint{$package}=0;
387 COMMAND: foreach my $command (reverse @log) {
388 foreach my $i (0..$#sequence) {
389 if ($command eq $sequence[$i]) {
390 $startpoint{$package}=$i+1;
398 # Figure out what point in the sequence to go to.
399 my $stoppoint=$#sequence;
401 $stoppoint=command_pos($dh{UNTIL}, @sequence);
403 elsif ($dh{BEFORE}) {
404 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
407 # Now run the commands in the sequence.
408 foreach my $i (0..$stoppoint) {
409 # Figure out which packages need to run this command.
411 foreach my $package (@packages) {
412 if ($startpoint{$package} > $i ||
413 $logged{$package}{$sequence[$i]}) {
414 push @exclude, $package;
418 if (@exclude eq @packages) {
419 # Command already done for all packages.
423 run($sequence[$i], \@packages, \@exclude, @options);
428 my @packages=@{shift()};
429 my @exclude=@{shift()};
432 # Check for override targets in debian/rules and
433 # run them instead of running the command directly.
434 my $override_command;
435 if (rules_explicit_target("override_".$command)) {
436 $override_command=$command;
437 # This passes the options through to commands called
439 $ENV{DH_INTERNAL_OPTIONS}=join(" ", @options);
440 $command="debian/rules";
441 @options="override_".$override_command;
444 # If some packages are excluded, add flags
445 # to prevent them from being acted on.
446 push @options, map { "-N$_" } @exclude;
449 # 3 space indent lines the command being run up under the
450 # sequence name after "dh ".
451 print " ".escape_shell($command, @options)."\n";
454 my $ret=system($command, @options);
455 if ($ret >> 8 != 0) {
462 if (defined $override_command) {
463 delete $ENV{DH_INTERNAL_OPTIONS};
464 # Need to handle logging for overriden commands here,
465 # because the actual debhelper command may not have
466 # been run by the rules file target.
467 my %packages=map { $_ => 1 } @packages;
468 map { delete $packages{$_} } @exclude;
469 Debian::Debhelper::Dh_Lib::write_log($override_command, keys %packages);
476 my $ext=pkgext($package);
479 open(LOG, "<", "debian/${ext}debhelper.log") || return;
483 $logged{$package}{$_}=1;
492 my $ext=pkgext($package);
494 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
503 sub rules_explicit_target {
504 # Checks if a specified target exists as an explicit target
507 my $processing_targets = 0;
508 my $not_a_target = 0;
510 if (! $rules_parsed) {
511 open(MAKE, "make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
513 if ($processing_targets) {
514 if (/^# Not a target:/) {
517 if (!$not_a_target && /^([^#:]+)::?/ && !exists $targets{$1}) {
519 # NOTE: if it is a depenency of .PHONY it will be
520 # defined too but that's ok.
523 # "Not a target:" is always followed by a target name,
524 # so resetting this one here is safe.
527 } elsif (/^# Files$/) {
528 $processing_targets = 1;
535 return exists $targets{$target};
544 This program is a part of debhelper.
548 Joey Hess <joeyh@debian.org>