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
185 If the package's source tree might get files with names
186 like build or clean in it, the rules file would not
187 run targets with the same names. This issue can be worked
188 around by passing -B to make.
194 If your package is a python package, dh will use dh_pysupport by
195 default. This is how to use dh_pycentral instead.
199 dh --with python_central
203 # Stash this away before init modifies it.
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}},$value;
218 # Definitions of sequences.
220 $sequences{build} = [qw{
226 $sequences{clean} = [qw{
231 $sequences{install} = [@{$sequences{build}}, qw{
279 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
280 $sequences{binary} = [@{$sequences{install}}, qw{
285 $sequences{'binary-arch'} = [@{$sequences{binary}}];
287 # --with python-support is enabled by default, at least for now
288 unshift @{$dh{WITH}}, "python-support";
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}}];
325 foreach my $addon (@{$dh{WITH}}) {
326 my $mod="Debian::Debhelper::Sequence::$addon";
330 error("--with $addon not supported or failed to load module $mod");
334 # Get the sequence of commands to run.
336 error "specify a sequence to run";
339 if ($sequence eq 'debian/rules' ||
340 $sequence =~ /^override_dh_/) {
341 # make -B causes the rules file to be run as a target
342 # and support completly empty override targets
345 elsif (! exists $sequences{$sequence}) {
346 error "Unknown sequence $sequence (choose from: ".
347 join(" ", sort keys %sequences).")";
349 my @sequence=@{$sequences{$sequence}};
351 # The list of all packages that can be acted on.
352 my @packages=@{$dh{DOPACKAGES}};
354 # Get the options to pass to commands in the sequence.
355 # Filter out options intended only for this program.
357 if ($sequence eq 'binary-arch') {
359 # as an optimisation, remove from the list any packages
360 # that are not arch dependent
361 my %arch_packages = map { $_ => 1 } getpackages("arch");
362 @packages = grep { $arch_packages{$_} } @packages;
364 elsif ($sequence eq 'binary-indep') {
366 # ditto optimisation for arch indep
367 my %indep_packages = map { $_ => 1 } getpackages("indep");
368 @packages = grep { $indep_packages{$_} } @packages;
371 my $opt=shift @ARGV_orig;
372 next if $opt eq $sequence;
373 if ($opt =~ /^--?(after|until|before|with)$/) {
377 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with)=)/) {
383 # Figure out at what point in the sequence to start for each package.
386 foreach my $package (@packages) {
387 my @log=loadlog($package);
389 # Run commands in the sequence that come after the
391 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
392 # Write a dummy log entry indicating that the specified
393 # command was, in fact, run. This handles the case where
394 # no commands remain to run after it, communicating to
395 # future dh instances that the specified command should not
397 writelog($package, $sequence[$startpoint{$package}-1]);
399 elsif ($dh{REMAINING}) {
400 # Start at the beginning so all remaining commands will get
402 $startpoint{$package}=0;
405 # Find the last logged command that is in the sequence, and
406 # continue with the next command after it. If no logged
407 # command is in the sequence, we're starting at the beginning..
408 $startpoint{$package}=0;
409 COMMAND: foreach my $command (reverse @log) {
410 foreach my $i (0..$#sequence) {
411 if ($command eq $sequence[$i]) {
412 $startpoint{$package}=$i+1;
420 # Figure out what point in the sequence to go to.
421 my $stoppoint=$#sequence;
423 $stoppoint=command_pos($dh{UNTIL}, @sequence);
425 elsif ($dh{BEFORE}) {
426 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
429 # Now run the commands in the sequence.
430 foreach my $i (0..$stoppoint) {
431 # Figure out which packages need to run this command.
433 foreach my $package (@packages) {
434 if ($startpoint{$package} > $i ||
435 $logged{$package}{$sequence[$i]}) {
436 push @exclude, $package;
440 if (@exclude eq @packages) {
441 # Command already done for all packages.
445 run($sequence[$i], \@packages, \@exclude, @options);
450 my @packages=@{shift()};
451 my @exclude=@{shift()};
454 # Check for override targets in debian/rules and
455 # run them instead of running the command directly.
456 my $override_command;
457 if (rules_explicit_target("override_".$command)) {
458 $override_command=$command;
459 # This passes the options through to commands called
461 $ENV{DH_INTERNAL_OPTIONS}=join(" ", @options);
462 $command="debian/rules";
463 @options="override_".$override_command;
466 # If some packages are excluded, add flags
467 # to prevent them from being acted on.
468 push @options, map { "-N$_" } @exclude;
471 # 3 space indent lines the command being run up under the
472 # sequence name after "dh ".
473 print " ".escape_shell($command, @options)."\n";
476 my $ret=system($command, @options);
477 if ($ret >> 8 != 0) {
484 if (defined $override_command) {
485 delete $ENV{DH_INTERNAL_OPTIONS};
486 # Need to handle logging for overriden commands here,
487 # because the actual debhelper command may not have
488 # been run by the rules file target.
489 my %packages=map { $_ => 1 } @packages;
490 map { delete $packages{$_} } @exclude;
491 Debian::Debhelper::Dh_Lib::write_log($override_command, keys %packages);
498 my $ext=pkgext($package);
501 open(LOG, "<", "debian/${ext}debhelper.log") || return;
505 $logged{$package}{$_}=1;
514 my $ext=pkgext($package);
516 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
525 sub rules_explicit_target {
526 # Checks if a specified target exists as an explicit target
530 if (! $rules_parsed) {
531 my $processing_targets = 0;
532 my $not_a_target = 0;
533 open(MAKE, "make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
535 if ($processing_targets) {
536 if (/^# Not a target:/) {
540 if (!$not_a_target && /^([^#:]+)::?/) {
542 # NOTE: if it is a depenency
543 # of .PHONY it will be
544 # defined too but that's ok.
547 # "Not a target:" is always followed by
548 # a target name, so resetting this one
552 } elsif (/^# Files$/) {
553 $processing_targets = 1;
560 return exists $targets{$target};
569 This program is a part of debhelper.
573 Joey Hess <joeyh@debian.org>