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.0.50 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 the PROGRAMMING file for documentation about
54 the sequence addon interface.
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.
93 foreach my $i (0..$#sequence) {
94 if ($command eq $sequence[$i]) {
100 foreach my $i (0..$#sequence) {
101 if ($sequence[$i] =~ /\Q$command\E/) {
106 error "command specification \"$command\" does not match any command in the sequence"
115 To see what commands are included in a sequence, without actually doing
118 dh binary-arch --no-act
120 This is a very simple rules file, for packages where the default sequences of
121 commands work with no additional options.
127 Often you'll want to pass an option to a specific debhelper command. The
128 easy way to do with is by adding an override target for that command.
137 override_dh_installdocs:
138 dh_installdocs README TODO
140 Sometimes the automated dh_auto_configure and dh_auto_build can't guess
141 what to do for a strange package. Here's how to avoid running either
142 and instead run your own commands.
148 override_dh_auto_configure:
151 override_dh_auto_build:
152 make universe-explode-in-delight
154 Another common case is wanting to do something manually before or
155 after a particular debhelper command is run.
161 override_dh_fixperms:
163 chmod 4755 debian/foo/usr/bin/foo
165 If your package is a python package, dh will use dh_pysupport by
166 default. This is how to use dh_pycentral instead.
170 dh --with python-central $@
174 # Stash this away before init modifies it.
178 "until=s" => \$dh{UNTIL},
179 "after=s" => \$dh{AFTER},
180 "before=s" => \$dh{BEFORE},
181 "remaining" => \$dh{REMAINING},
183 my ($option,$value)=@_;
184 push @{$dh{WITH}},$value;
189 # Definitions of sequences.
191 $sequences{build} = [qw{
197 $sequences{clean} = [qw{
202 $sequences{install} = [@{$sequences{build}}, qw{
250 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
251 $sequences{binary} = [@{$sequences{install}}, qw{
256 $sequences{'binary-arch'} = [@{$sequences{binary}}];
258 # --with python-support is enabled by default, at least for now
259 unshift @{$dh{WITH}}, "python-support";
261 # sequence addon interface
266 foreach my $sequence (keys %sequences) {
267 my @list=@{$sequences{$sequence}};
268 next unless grep $existing, @list;
270 foreach my $command (@list) {
271 if ($command eq $existing) {
272 push @new, $new if $offset < 0;
274 push @new, $new if $offset > 0;
280 $sequences{$sequence}=\@new;
291 foreach my $sequence (keys %sequences) {
292 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
296 foreach my $addon (@{$dh{WITH}}) {
297 my $mod="Debian::Debhelper::Sequence::$addon";
301 error("--with $addon not supported or failed to load module $mod");
305 # Get the sequence of commands to run.
307 error "specify a sequence to run";
310 if ($sequence eq 'debian/rules' ||
311 $sequence =~ /^override_dh_/) {
312 # make -B causes the rules file to be run as a target
313 # and support completly empty override targets
316 elsif (! exists $sequences{$sequence}) {
317 error "Unknown sequence $sequence (choose from: ".
318 join(" ", sort keys %sequences).")";
320 my @sequence=@{$sequences{$sequence}};
322 # The list of all packages that can be acted on.
323 my @packages=@{$dh{DOPACKAGES}};
325 # Get the options to pass to commands in the sequence.
326 # Filter out options intended only for this program.
328 if ($sequence eq 'binary-arch') {
330 # as an optimisation, remove from the list any packages
331 # that are not arch dependent
332 my %arch_packages = map { $_ => 1 } getpackages("arch");
333 @packages = grep { $arch_packages{$_} } @packages;
335 elsif ($sequence eq 'binary-indep') {
337 # ditto optimisation for arch indep
338 my %indep_packages = map { $_ => 1 } getpackages("indep");
339 @packages = grep { $indep_packages{$_} } @packages;
342 my $opt=shift @ARGV_orig;
343 next if $opt eq $sequence;
344 if ($opt =~ /^--?(after|until|before|with)$/) {
348 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with)=)/) {
354 # Figure out at what point in the sequence to start for each package.
357 foreach my $package (@packages) {
358 my @log=load_log($package, \%logged);
360 # Run commands in the sequence that come after the
362 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
363 # Write a dummy log entry indicating that the specified
364 # command was, in fact, run. This handles the case where
365 # no commands remain to run after it, communicating to
366 # future dh instances that the specified command should not
368 write_log($sequence[$startpoint{$package}-1], $package);
370 elsif ($dh{REMAINING}) {
371 # Start at the beginning so all remaining commands will get
373 $startpoint{$package}=0;
376 # Find the last logged command that is in the sequence, and
377 # continue with the next command after it. If no logged
378 # command is in the sequence, we're starting at the beginning..
379 $startpoint{$package}=0;
380 COMMAND: foreach my $command (reverse @log) {
381 foreach my $i (0..$#sequence) {
382 if ($command eq $sequence[$i]) {
383 $startpoint{$package}=$i+1;
391 # Figure out what point in the sequence to go to.
392 my $stoppoint=$#sequence;
394 $stoppoint=command_pos($dh{UNTIL}, @sequence);
396 elsif ($dh{BEFORE}) {
397 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
400 # Now run the commands in the sequence.
401 foreach my $i (0..$stoppoint) {
402 # Figure out which packages need to run this command.
404 foreach my $package (@packages) {
405 if ($startpoint{$package} > $i ||
406 $logged{$package}{$sequence[$i]}) {
407 push @exclude, $package;
411 if (@exclude eq @packages) {
412 # Command already done for all packages.
416 run($sequence[$i], \@packages, \@exclude, @options);
421 my @packages=@{shift()};
422 my @exclude=@{shift()};
425 # If some packages are excluded, add flags
426 # to prevent them from being acted on.
427 push @options, map { "-N$_" } @exclude;
429 # Check for override targets in debian/rules and
430 # run them instead of running the command directly.
431 my $override_command;
432 if (rules_explicit_target("override_".$command)) {
433 $override_command=$command;
434 # This passes the options through to commands called
436 $ENV{DH_INTERNAL_OPTIONS}=join(" ", @options);
437 $command="debian/rules";
438 @options="override_".$override_command;
441 # 3 space indent lines the command being run up under the
442 # sequence name after "dh ".
443 print " ".escape_shell($command, @options)."\n";
446 my $ret=system($command, @options);
447 if ($ret >> 8 != 0) {
454 if (defined $override_command) {
455 delete $ENV{DH_INTERNAL_OPTIONS};
456 # Need to handle logging for overriden commands here,
457 # because the actual debhelper command may not have
458 # been run by the rules file target.
459 my %packages=map { $_ => 1 } @packages;
460 map { delete $packages{$_} } @exclude;
461 write_log($override_command, keys %packages);
470 sub rules_explicit_target {
471 # Checks if a specified target exists as an explicit target
475 if (! $rules_parsed) {
476 my $processing_targets = 0;
477 my $not_a_target = 0;
478 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
480 if ($processing_targets) {
481 if (/^# Not a target:/) {
485 if (!$not_a_target && /^([^#:]+)::?/) {
487 # NOTE: if it is a depenency
488 # of .PHONY it will be
489 # defined too but that's ok.
492 # "Not a target:" is always followed by
493 # a target name, so resetting this one
497 } elsif (/^# Files$/) {
498 $processing_targets = 1;
505 return exists $targets{$target};
514 This program is a part of debhelper.
518 Joey Hess <joeyh@debian.org>