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>
152 install: build install-stamp
160 binary-indep: install
163 binary: binary-arch binary-indep
165 Often you'll want to pass an option to ./configure. This uses dh to run all
166 commands before L<dh_auto_configure(1)>, then runs that command by hand,
167 and then finished up by running the rest of the sequence. You could also
168 run ./configure by hand, instead of bothering with using dh_auto_configure.
169 And if necessary, you can add commands to run automake, etc here too.
173 dh build --before configure
174 dh_auto_configure -- --kitchen-sink=yes
175 dh build --after configure
178 Here's how to skip two automated in a row (configure and build), and
179 instead run the commands by hand.
183 dh build --before configure
185 make universe-explode-in-delight
186 dh build --after build
189 Another common case is wanting to run some code manually after a particular
190 debhelper command is run.
192 install: build install-stamp
194 dh install --until dh_fixperms
195 # dh_fixperms has run, now override it for one program
196 chmod 4755 debian/foo/usr/bin/foo
198 dh install --after dh_fixperms
201 It's also fine to run debhelper commands early. Just make sure that at
202 least dh_prep is run from the sequence first, and be sure to use the
203 B<--remaining> option to ensure that commands that normally come before
204 those in the sequence are still run.
206 install: build install-stamp
208 dh install --until dh_prep
209 dh_installdocs README TODO
210 dh_installchangelogs Changes
211 dh install --remaining
216 dh binary-arch --remaining
220 # Stash this away before init modifies it.
226 # Definitions of sequences.
228 $sequences{build} = [qw{
234 $sequences{clean} = [qw{
239 $sequences{install} = [@{$sequences{build}}, qw{
287 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
288 $sequences{binary} = [@{$sequences{install}}, qw{
293 $sequences{'binary-arch'} = [@{$sequences{binary}}];
295 # --with python-support is enabled by default, at least for now
296 unshift @{$dh{WITH}}, "python-support";
298 # sequence addon interface
303 foreach my $sequence (keys %sequences) {
304 my @list=@{$sequences{$sequence}};
305 next unless grep $existing, @list;
307 foreach my $command (@list) {
308 if ($command eq $existing) {
309 push @new, $new if $offset < 0;
311 push @new, $new if $offset > 0;
317 $sequences{$sequence}=\@new;
328 foreach my $sequence (keys %sequences) {
329 $sequences{$sequence}=[grep { $_ ne $command } @{$sequences{$sequence}}];
333 foreach my $addon (@{$dh{WITH}}) {
334 my $mod="Debian::Debhelper::Sequence::$addon";
338 error("--with $addon not supported or failed to load module $mod");
342 # Get the sequence of commands to run.
344 error "specify a sequence to run";
347 if (! exists $sequences{$sequence}) {
348 error "Unknown sequence $sequence (chose from: ".
349 join(" ", sort keys %sequences).")";
351 my @sequence=@{$sequences{$sequence}};
353 # The list of all packages that can be acted on.
354 my @packages=@{$dh{DOPACKAGES}};
356 # Get the options to pass to commands in the sequence.
357 # Filter out options intended only for this program.
359 if ($sequence eq 'binary-arch') {
361 # as an optimisation, remove from the list any packages
362 # that are not arch dependent
363 my %arch_packages = map { $_ => 1 } getpackages("arch");
364 @packages = grep { $arch_packages{$_} } @packages;
366 elsif ($sequence eq 'binary-indep') {
368 # ditto optimisation for arch indep
369 my %indep_packages = map { $_ => 1 } getpackages("indep");
370 @packages = grep { $indep_packages{$_} } @packages;
373 my $opt=shift @ARGV_orig;
374 next if $opt eq $sequence;
375 if ($opt =~ /^--?(after|until|before|with)$/) {
379 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before|with)=)/) {
385 # Figure out at what point in the sequence to start for each package.
388 foreach my $package (@packages) {
389 my @log=loadlog($package);
391 # Run commands in the sequence that come after the
393 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
394 # Write a dummy log entry indicating that the specified
395 # command was, in fact, run. This handles the case where
396 # no commands remain to run after it, communicating to
397 # future dh instances that the specified command should not
399 writelog($package, $sequence[$startpoint{$package}-1]);
401 elsif ($dh{REMAINING}) {
402 # Start at the beginning so all remaining commands will get
404 $startpoint{$package}=0;
407 # Find the last logged command that is in the sequence, and
408 # continue with the next command after it. If no logged
409 # command is in the sequence, we're starting at the beginning..
410 $startpoint{$package}=0;
411 COMMAND: foreach my $command (reverse @log) {
412 foreach my $i (0..$#sequence) {
413 if ($command eq $sequence[$i]) {
414 $startpoint{$package}=$i+1;
422 # Figure out what point in the sequence to go to.
423 my $stoppoint=$#sequence;
425 $stoppoint=command_pos($dh{UNTIL}, @sequence);
427 elsif ($dh{BEFORE}) {
428 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
431 # Now run the commands in the sequence.
432 foreach my $i (0..$stoppoint) {
433 # Figure out which packages need to run this command.
435 foreach my $package (@packages) {
436 if ($startpoint{$package} > $i ||
437 $logged{$package}{$sequence[$i]}) {
438 push @exclude, $package;
442 if (@exclude eq @packages) {
443 # Command already done for all packages.
447 # Run command for all packages.
448 run($sequence[$i], @options);
451 # Run command for only a subset of packages.
452 run($sequence[$i], @options,
453 map { "-N$_" } @exclude);
461 # 3 space indent lines the command being run up under the
462 # sequence name after "dh ".
463 print " ".escape_shell($command, @options)."\n";
466 my $ret=system($command, @options);
467 if ($ret >> 8 != 0) {
478 my $ext=pkgext($package);
481 open(LOG, "<", "debian/${ext}debhelper.log") || return;
485 $logged{$package}{$_}=1;
494 my $ext=pkgext($package);
496 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
505 This program is a part of debhelper.
509 Joey Hess <joeyh@debian.org>