5 dh - debhelper command sequencer
10 use Debian::Debhelper::Dh_Lib;
14 B<dh> sequence [B<--until> I<cmd>] [B<--before> I<cmd>] [B<--after> I<cmd>] [B<--remaining>] [B<--with> I<addon>] [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.
41 =item B<--until> I<cmd>
43 Run commands in the sequence until and including I<cmd>, then stop.
45 =item B<--before> I<cmd>
47 Run commands in the sequence before I<cmd>, then stop.
49 =item B<--after> I<cmd>
51 Run commands in the sequence that come after I<cmd>.
55 Run all commands in the sequence that have yet to be run.
57 =item B<--with> I<addon>
59 Add the debhelper commands specified by the given addon to appropriate places
60 in the sequence of commands that is run. This option can be repeated more
61 than once, and is used when there is a third-party package that provides
62 debhelper commands. See "SEQUENCE ADDONS" below for documentation about what
63 such packages should do to be supported by --with.
67 All other options passed to dh are passed on to each command it runs. This
68 can be used to set an option like "-v" or "-X" or "-N", as well as for more
71 =head1 COMMAND SPECIFICATION
73 I<cmd> can be a full name of a debhelper command, or a substring. It'll first
74 search for a command in the sequence exactly matching the name, to avoid any
75 ambiguity. If there are multiple substring matches, the last one in the
76 sequence will be used.
78 =head1 SEQUENCE ADDONS
80 When B<--with> I<addon> is used, dh loads the perl module
81 Debian::Debhelper::Sequence::I<addon>. Two functions are provided to let
82 the module add its commands to sequences:
86 =item Debian::Debhelper::Dh_Lib::insert_before(existing_command, new_command)
88 Insert I<new_command> in sequences before I<existing_command>.
90 =item Debian::Debhelper::Dh_Lib::insert_after(existing_command, new_command)
92 Insert I<new_command> in sequences after I<existing_command>.
94 =item Debian::Debhelper::Dh_Lib::remove_command(existing_command)
96 Remove I<existing_command> from the list of commands to run.
106 foreach my $i (0..$#sequence) {
107 if ($command eq $sequence[$i]) {
113 foreach my $i (0..$#sequence) {
114 if ($sequence[$i] =~ /\Q$command\E/) {
119 error "command specification \"$command\" does not match any command in the sequence"
128 To see what commands are included in a sequence, without actually doing
131 dh binary-arch --no-act
133 This is a very simple rules file, for packages where the default sequences of
134 commands work with no additional options.
140 This is a simple rules file that is a good starting place for customisation.
141 (It's also available in F</usr/share/doc/debhelper/examples/rules.simple>
153 install: build install-stamp
161 binary-indep: install
164 binary: binary-arch binary-indep
166 Often you'll want to pass an option to ./configure. This uses dh to run all
167 commands before L<dh_auto_configure(1)>, then runs that command by hand,
168 and then finishes up by running the rest of the sequence. You could also
169 run ./configure by hand, instead of bothering with using dh_auto_configure.
170 And if necessary, you can add commands to run automake, etc here too.
174 dh build --before configure
175 dh_auto_configure -- --kitchen-sink=yes
176 dh build --after configure
179 Here's how to skip two automated steps in a row (configure and build), and
180 instead run the commands by hand.
184 dh build --before configure
186 make universe-explode-in-delight
187 dh build --after build
190 Another common case is wanting to run some code manually after a particular
191 debhelper command is run.
193 install: build install-stamp
195 dh install --until dh_fixperms
196 # dh_fixperms has run, now override it for one program
197 chmod 4755 debian/foo/usr/bin/foo
199 dh install --after dh_fixperms
202 It's also fine to run debhelper commands early. Just make sure that at
203 least dh_prep is run from the sequence first, and be sure to use the
204 B<--remaining> option to ensure that commands that normally come before
205 those in the sequence are still run.
207 install: build install-stamp
209 dh install --until dh_prep
210 dh_installdocs README TODO
211 dh_installchangelogs Changes
212 dh install --remaining
217 dh binary-arch --remaining
221 # Stash this away before init modifies it.
225 "until=s" => \$dh{UNTIL},
226 "after=s" => \$dh{AFTER},
227 "before=s" => \$dh{BEFORE},
228 "remaining" => \$dh{REMAINING},
230 my ($option,$value)=@_;
231 push @{$dh{WITH}},$value;
236 # Definitions of sequences.
238 $sequences{build} = [qw{
244 $sequences{clean} = [qw{
249 $sequences{install} = [@{$sequences{build}}, qw{
297 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
298 $sequences{binary} = [@{$sequences{install}}, qw{
303 $sequences{'binary-arch'} = [@{$sequences{binary}}];
305 # --with python-support is enabled by default, at least for now
306 unshift @{$dh{WITH}}, "python-support";
308 # sequence addon interface
313 foreach my $sequence (keys %sequences) {
314 my @list=@{$sequences{$sequence}};
315 next unless grep $existing, @list;
317 foreach my $command (@list) {
318 if ($command eq $existing) {
319 push @new, $new if $offset < 0;
321 push @new, $new if $offset > 0;
327 $sequences{$sequence}=\@new;
338 foreach my $sequence (keys %sequences) {
339 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
343 foreach my $addon (@{$dh{WITH}}) {
344 my $mod="Debian::Debhelper::Sequence::$addon";
348 error("--with $addon not supported or failed to load module $mod");
352 # Get the sequence of commands to run.
354 error "specify a sequence to run";
357 if (! exists $sequences{$sequence}) {
358 error "Unknown sequence $sequence (choose from: ".
359 join(" ", sort keys %sequences).")";
361 my @sequence=@{$sequences{$sequence}};
363 # The list of all packages that can be acted on.
364 my @packages=@{$dh{DOPACKAGES}};
366 # Get the options to pass to commands in the sequence.
367 # Filter out options intended only for this program.
369 if ($sequence eq 'binary-arch') {
371 # as an optimisation, remove from the list any packages
372 # that are not arch dependent
373 my %arch_packages = map { $_ => 1 } getpackages("arch");
374 @packages = grep { $arch_packages{$_} } @packages;
376 elsif ($sequence eq 'binary-indep') {
378 # ditto optimisation for arch indep
379 my %indep_packages = map { $_ => 1 } getpackages("indep");
380 @packages = grep { $indep_packages{$_} } @packages;
383 my $opt=shift @ARGV_orig;
384 next if $opt eq $sequence;
385 if ($opt =~ /^--?(after|until|before|with)$/) {
389 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with)=)/) {
395 # Figure out at what point in the sequence to start for each package.
398 foreach my $package (@packages) {
399 my @log=loadlog($package);
401 # Run commands in the sequence that come after the
403 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
404 # Write a dummy log entry indicating that the specified
405 # command was, in fact, run. This handles the case where
406 # no commands remain to run after it, communicating to
407 # future dh instances that the specified command should not
409 writelog($package, $sequence[$startpoint{$package}-1]);
411 elsif ($dh{REMAINING}) {
412 # Start at the beginning so all remaining commands will get
414 $startpoint{$package}=0;
417 # Find the last logged command that is in the sequence, and
418 # continue with the next command after it. If no logged
419 # command is in the sequence, we're starting at the beginning..
420 $startpoint{$package}=0;
421 COMMAND: foreach my $command (reverse @log) {
422 foreach my $i (0..$#sequence) {
423 if ($command eq $sequence[$i]) {
424 $startpoint{$package}=$i+1;
432 # Figure out what point in the sequence to go to.
433 my $stoppoint=$#sequence;
435 $stoppoint=command_pos($dh{UNTIL}, @sequence);
437 elsif ($dh{BEFORE}) {
438 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
441 # Now run the commands in the sequence.
442 foreach my $i (0..$stoppoint) {
443 # Figure out which packages need to run this command.
445 foreach my $package (@packages) {
446 if ($startpoint{$package} > $i ||
447 $logged{$package}{$sequence[$i]}) {
448 push @exclude, $package;
452 if (@exclude eq @packages) {
453 # Command already done for all packages.
457 # Run command for all packages.
458 run($sequence[$i], @options);
461 # Run command for only a subset of packages.
462 run($sequence[$i], @options,
463 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) {
488 my $ext=pkgext($package);
491 open(LOG, "<", "debian/${ext}debhelper.log") || return;
495 $logged{$package}{$_}=1;
504 my $ext=pkgext($package);
506 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
515 This program is a part of debhelper.
519 Joey Hess <joeyh@debian.org>