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:
184 # Stash this away before init modifies it.
187 # python-support is enabled by default, at least for now
188 # (and comes first so python-central loads later and can disable it).
189 unshift @ARGV, "--with=python-support";
192 "until=s" => \$dh{UNTIL},
193 "after=s" => \$dh{AFTER},
194 "before=s" => \$dh{BEFORE},
195 "remaining" => \$dh{REMAINING},
197 my ($option,$value)=@_;
198 push @{$dh{WITH}},split(",", $value);
201 my ($option,$value)=@_;
202 @{$dh{WITH}} = grep { $_ ne $value } @{$dh{WITH}};
207 # Definitions of sequences.
209 $sequences{build} = [qw{
215 $sequences{clean} = [qw{
220 $sequences{install} = [@{$sequences{build}}, qw{
268 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
269 $sequences{binary} = [@{$sequences{install}}, qw{
274 $sequences{'binary-arch'} = [@{$sequences{binary}}];
276 # sequence addon interface
281 foreach my $sequence (keys %sequences) {
282 my @list=@{$sequences{$sequence}};
283 next unless grep $existing, @list;
285 foreach my $command (@list) {
286 if ($command eq $existing) {
287 push @new, $new if $offset < 0;
289 push @new, $new if $offset > 0;
295 $sequences{$sequence}=\@new;
306 foreach my $sequence (keys %sequences) {
307 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
311 foreach my $addon (@{$dh{WITH}}) {
312 my $mod="Debian::Debhelper::Sequence::$addon";
316 error("--with $addon not supported or failed to load module $mod");
320 # Get the sequence of commands to run.
322 error "specify a sequence to run";
325 if ($sequence eq 'debian/rules' ||
326 $sequence =~ /^override_dh_/) {
327 # make -B causes the rules file to be run as a target
328 # and support completly empty override targets
331 elsif (! exists $sequences{$sequence}) {
332 error "Unknown sequence $sequence (choose from: ".
333 join(" ", sort keys %sequences).")";
335 my @sequence=@{$sequences{$sequence}};
337 # The list of all packages that can be acted on.
338 my @packages=@{$dh{DOPACKAGES}};
340 # Get the options to pass to commands in the sequence.
341 # Filter out options intended only for this program.
343 if ($sequence eq 'binary-arch') {
345 # as an optimisation, remove from the list any packages
346 # that are not arch dependent
347 my %arch_packages = map { $_ => 1 } getpackages("arch");
348 @packages = grep { $arch_packages{$_} } @packages;
350 elsif ($sequence eq 'binary-indep') {
352 # ditto optimisation for arch indep
353 my %indep_packages = map { $_ => 1 } getpackages("indep");
354 @packages = grep { $indep_packages{$_} } @packages;
357 my $opt=shift @ARGV_orig;
358 next if $opt eq $sequence;
359 if ($opt =~ /^--?(after|until|before|with|without)$/) {
363 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with|without)=)/) {
369 # Figure out at what point in the sequence to start for each package.
372 foreach my $package (@packages) {
373 my @log=load_log($package, \%logged);
375 # Run commands in the sequence that come after the
377 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
378 # Write a dummy log entry indicating that the specified
379 # command was, in fact, run. This handles the case where
380 # no commands remain to run after it, communicating to
381 # future dh instances that the specified command should not
383 write_log($sequence[$startpoint{$package}-1], $package);
385 elsif ($dh{REMAINING}) {
386 # Start at the beginning so all remaining commands will get
388 $startpoint{$package}=0;
391 # Find the last logged command that is in the sequence, and
392 # continue with the next command after it. If no logged
393 # command is in the sequence, we're starting at the beginning..
394 $startpoint{$package}=0;
395 COMMAND: foreach my $command (reverse @log) {
396 foreach my $i (0..$#sequence) {
397 if ($command eq $sequence[$i]) {
398 $startpoint{$package}=$i+1;
406 # Figure out what point in the sequence to go to.
407 my $stoppoint=$#sequence;
409 $stoppoint=command_pos($dh{UNTIL}, @sequence);
411 elsif ($dh{BEFORE}) {
412 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
415 # Now run the commands in the sequence.
416 foreach my $i (0..$stoppoint) {
417 # Figure out which packages need to run this command.
419 foreach my $package (@packages) {
420 if ($startpoint{$package} > $i ||
421 $logged{$package}{$sequence[$i]}) {
422 push @exclude, $package;
426 if (@exclude eq @packages) {
427 # Command already done for all packages.
431 run($sequence[$i], \@packages, \@exclude, @options);
436 my @packages=@{shift()};
437 my @exclude=@{shift()};
440 # If some packages are excluded, add flags
441 # to prevent them from being acted on.
442 push @options, map { "-N$_" } @exclude;
444 # Check for override targets in debian/rules and
445 # run them instead of running the command directly.
446 my $override_command;
447 if (rules_explicit_target("override_".$command)) {
448 $override_command=$command;
449 # This passes the options through to commands called
451 $ENV{DH_INTERNAL_OPTIONS}=join(" ", @options);
452 $command="debian/rules";
453 @options="override_".$override_command;
456 # 3 space indent lines the command being run up under the
457 # sequence name after "dh ".
458 print " ".escape_shell($command, @options)."\n";
461 my $ret=system($command, @options);
462 if ($ret >> 8 != 0) {
469 if (defined $override_command) {
470 delete $ENV{DH_INTERNAL_OPTIONS};
471 # Need to handle logging for overriden commands here,
472 # because the actual debhelper command may not have
473 # been run by the rules file target.
474 my %packages=map { $_ => 1 } @packages;
475 map { delete $packages{$_} } @exclude;
476 write_log($override_command, keys %packages);
485 sub rules_explicit_target {
486 # Checks if a specified target exists as an explicit target
490 if (! $rules_parsed) {
491 my $processing_targets = 0;
492 my $not_a_target = 0;
493 open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |");
495 if ($processing_targets) {
496 if (/^# Not a target:/) {
500 if (!$not_a_target && /^([^#:]+)::?/) {
502 # NOTE: if it is a depenency
503 # of .PHONY it will be
504 # defined too but that's ok.
507 # "Not a target:" is always followed by
508 # a target name, so resetting this one
512 } elsif (/^# Files$/) {
513 $processing_targets = 1;
520 return exists $targets{$target};
529 This program is a part of debhelper.
533 Joey Hess <joeyh@debian.org>