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>.
102 foreach my $i (0..$#sequence) {
103 if ($command eq $sequence[$i]) {
109 foreach my $i (0..$#sequence) {
110 if ($sequence[$i] =~ /\Q$command\E/) {
115 error "command specification \"$command\" does not match any command in the sequence"
124 To see what commands are included in a sequence, without actually doing
127 dh binary-arch --no-act
129 This is a very simple rules file, for packages where the default seqences of
130 commands work with no additional options.
136 This is a simple rules file that is a good starting place for customisation.
137 (It's also available in F</usr/share/doc/debhelper/examples/rules.simple>
153 binary-indep: install
156 binary: binary-arch binary-indep
158 Often you'll want to pass an option to ./configure. This uses dh to run all
159 commands before L<dh_auto_configure(1)>, then runs that command by hand,
160 and then finished up by running the rest of the sequence. You could also
161 run ./configure by hand, instead of bothering with using dh_auto_configure.
162 And if necessary, you can add commands to run automake, etc here too.
165 dh build --before configure
166 dh_auto_configure --kitchen-sink=yes
167 dh build --after configure
169 Here's how to skip two automated in a row (configure and build), and
170 instead run the commands by hand.
173 dh build --before configure
175 make universe-explode-in-delight
176 dh build --after build
178 Another common case is wanting to run some code manually after a particular
179 debhelper command is run.
182 dh install --until dh_fixperms
183 # dh_fixperms has run, now override it for one program
184 chmod 4755 debian/foo/usr/bin/foo
186 dh install --after dh_fixperms
188 It's also fine to run debhelper commands early. Just make sure that at
189 least dh_prep is run from the squence first, and be sure to use the
190 B<--remaining> option to ensure that commands that normally come before
191 those in the sequence are still run.
194 dh install --until dh_prep
195 dh_installdocs README TODO
196 dh_installchangelogs Changes
197 dh install --remaining
201 dh binary-arch --remaining
205 # Stash this away before init modifies it.
211 # Definitions of sequences.
213 $sequences{build} = [qw{
219 $sequences{clean} = [qw{
224 $sequences{install} = [@{$sequences{build}}, qw{
272 $sequences{'binary-indep'} = [@{$sequences{install}}, @b];
273 $sequences{binary} = [@{$sequences{install}}, qw{
278 $sequences{'binary-arch'} = [@{$sequences{binary}}];
280 # --with python-support is enabled by default, at least for now
281 push @{$dh{WITH}}, "python-support";
283 # sequence addon interface
288 foreach my $sequence (keys %sequences) {
289 my @list=@{$sequences{$sequence}};
290 next unless grep $existing, @list;
292 foreach my $command (@list) {
293 if ($command eq $existing) {
294 push @new, $new if $offset < 0;
296 push @new, $new if $offset > 0;
302 $sequences{$sequence}=\@new;
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 (! exists $sequences{$sequence}) {
326 error "Unknown sequence $sequence (chose from: ".
327 join(" ", sort keys %sequences).")";
329 my @sequence=@{$sequences{$sequence}};
331 # The list of all packages that can be acted on.
332 my @packages=@{$dh{DOPACKAGES}};
334 # Get the options to pass to commands in the sequence.
335 # Filter out options intended only for this program.
337 if ($sequence eq 'binary-arch') {
339 # as an optimisation, remove from the list any packages
340 # that are not arch dependent
341 my %arch_packages = map { $_ => 1 } getpackages("arch");
342 @packages = grep { $arch_packages{$_} } @packages;
344 elsif ($sequence eq 'binary-indep') {
346 # ditto optimisation for arch indep
347 my %indep_packages = map { $_ => 1 } getpackages("indep");
348 @packages = grep { $indep_packages{$_} } @packages;
351 my $opt=shift @ARGV_orig;
352 next if $opt eq $sequence;
353 if ($opt =~ /^--?(after|until|before)$/) {
357 elsif ($opt =~ /^--?(no-act|remaining|(after|until|before)=)/) {
363 # Figure out at what point in the sequence to start for each package.
366 foreach my $package (@packages) {
367 my @log=loadlog($package);
369 # Run commands in the sequence that come after the
371 $startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
372 # Write a dummy log entry indicating that the specified
373 # command was, in fact, run. This handles the case where
374 # no commands remain to run after it, communicating to
375 # future dh instances that the specified command should not
377 writelog($package, $sequence[$startpoint{$package}-1]);
379 elsif ($dh{REMAINING}) {
380 # Start at the beginning so all remaining commands will get
382 $startpoint{$package}=0;
385 # Find the last logged command that is in the sequence, and
386 # continue with the next command after it. If no logged
387 # command is in the sequence, we're starting at the beginning..
388 $startpoint{$package}=0;
389 COMMAND: foreach my $command (reverse @log) {
390 foreach my $i (0..$#sequence) {
391 if ($command eq $sequence[$i]) {
392 $startpoint{$package}=$i+1;
400 # Figure out what point in the sequence to go to.
401 my $stoppoint=$#sequence;
403 $stoppoint=command_pos($dh{UNTIL}, @sequence);
405 elsif ($dh{BEFORE}) {
406 $stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
409 # Now run the commands in the sequence.
410 foreach my $i (0..$stoppoint) {
411 # Figure out which packages need to run this command.
413 foreach my $package (@packages) {
414 if ($startpoint{$package} > $i ||
415 $logged{$package}{$sequence[$i]}) {
416 push @exclude, $package;
420 if (@exclude eq @packages) {
421 # Command already done for all packages.
425 # Run command for all packages.
426 run($sequence[$i], @options);
429 # Run command for only a subset of packages.
430 run($sequence[$i], @options,
431 map { "-N$_" } @exclude);
439 # 3 space indent lines the command being run up under the
440 # sequence name after "dh ".
441 print " ".escape_shell($command, @options)."\n";
444 my $ret=system($command, @options);
445 if ($ret >> 8 != 0) {
456 my $ext=pkgext($package);
459 open(LOG, "<", "debian/${ext}debhelper.log") || return;
463 $logged{$package}{$_}=1;
472 my $ext=pkgext($package);
474 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
483 This program is a part of debhelper.
487 Joey Hess <joeyh@debian.org>