1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
#!/usr/bin/perl -w
=head1 NAME
dh - debhelper command sequencer
=cut
use strict;
use Debian::Debhelper::Dh_Lib;
=head1 SYNOPSIS
B<dh> sequence [B<--until> I<cmd>] [B<--before> I<cmd>] [B<--after> I<cmd>] [B<--remaining> [S<I<debhelper options>>]
=head1 DESCRIPTION
dh runs a sequence of debhelper commands. The supported sequences
correspond to the targets of a debian/rules file: "build", "clean",
"install", "binary-arch", "binary-indep", and "binary".
Commands in the binary-indep sequence are passed the "-i" option to ensure
they only work on binary independent packages, and commands in the
binary-arch sequences are passed the "-a" option to ensure they only work
on architecture dependent packages.
Options passed to dh are passed on to each command it runs. This can be
used to set an option like "-v" or "-X" or "-N", as well as for more
specialised options.
Each debhelper command will record when it's successfully run in
debian/package.debhelper.log. (Which dh_clean deletes.) So dh can tell
which commands have already been run, for which packages, and skip running
those commands again.
Each time dh is run, it examines the log, and finds the last logged command
that is in the specified sequence. It then continues with the next command
in the sequence. The B<--until>, B<--before>, B<--after>, and B<--remaining>
options can override this behavior.
=head1 OPTIONS
=over 4
=item B<--until> I<cmd>
Run commands in the sequence until and including I<cmd>, then stop.
=item B<--before> I<cmd>
Run commands in the sequence before I<cmd>, then stop.
=item B<--after> I<cmd>
Run commands in the sequence that come after I<cmd>.
=item B<--remaining>
Run all commands in the sequence that have yet to be run.
=head1 COMMAND SPECIFICATION
I<cmd> can be a full name of a debhelper command, or a substring. It'll first
search for a command in the sequence exactly matching the name, to avoid any
ambiguity. If there are multiple substring matches, the last one in the
sequence will be used.
=cut
sub command_pos {
my $command=shift;
my @sequence=@_;
foreach my $i (0..$#sequence) {
if ($command eq $sequence[$i]) {
return $i;
}
}
my @matches;
foreach my $i (0..$#sequence) {
if ($sequence[$i] =~ /\Q$command\E/) {
push @matches, $i;
}
}
if (! @matches) {
error "command specification \"$command\" does not match any command in the sequence"
}
else {
return pop @matches;
}
}
=head1 EXAMPLES
To see what commands are included in a sequence, without actually doing
anything:
dh binary-arch --no-act
This is a very simple rules file, for packages where the default seqences of
commands work with no additional options.
#!/usr/bin/make -f
%:
dh %@
This is a simple rules file that is a good starting place for customisation.
(It's also available in F</usr/share/doc/debhelper/examples/rules.simple>
#!/usr/bin/make -f
build:
dh build
clean:
dh clean
install: build
dh install
binary-arch: install
dh binary-arch
binary-indep: install
dh binary-indep
binary: binary-arch binary-indep
Often you'll want to pass an option to ./configure. This uses dh to run all
commands before L<dh_auto_configure(1)>, then runs that command by hand,
and then finished up by running the rest of the sequence. You could also
run ./configure by hand, instead of bothering with using dh_auto_configure.
And if necessary, you can add commands to run automake, etc here too.
build:
dh build --before configure
dh_auto_configure --kitchen-sink=yes
dh build --after configure
Here's how to skip two automated in a row (configure and build), and
instead run the commands by hand.
build:
dh build --before configure
./mondoconfig
make universe-explode-in-delight
dh build --after build
Another common case is wanting to run some code manually after a particular
debhelper command is run.
binary-arch: install
dh binary-arch --until dh_fixperms
# dh_fixperms has run, now override it for one program
chmod 4755 debian/foo/usr/bin/foo
# and continue
dh binary-arch --after dh_fixperms
It's also fine to run debhelper commands before starting the dh sequence.
Just be sure to use the B<--remaining> option to ensure that commands
that normally come before those in the sequence are still run.
binary-arch: install
dh_strip -X foo
dh_fixperms -X bar
dh binary-arch --remaining
=cut
# Stash this away before init modifies it.
my @ARGV_orig=@ARGV;
init();
# Definitions of sequences.
my %sequences;
$sequences{build} = [qw{
dh_testdir
dh_auto_configure
dh_auto_build
dh_auto_test
}],
$sequences{clean} = [qw{
dh_testdir
dh_auto_clean
dh_clean
}];
$sequences{install} = [@{$sequences{build}}, qw{
dh_testroot
dh_clean
dh_installdirs
dh_auto_install
dh_install
dh_installdocs
dh_installchangelogs
dh_installexamples
dh_installman
dh_installcatalogs
dh_installcron
dh_installdebconf
dh_installcatalogs
dh_installemacsen
dh_installifupdown
dh_installinfo
dh_installinit
dh_installmenu
dh_installmime
dh_installmodules
dh_installlogcheck
dh_installlogrotate
dh_installpam
dh_installppp
dh_installudev
dh_installwm
dh_installxfonts
dh_lintian
dh_desktop
dh_gconf
dh_icons
dh_perl
dh_pysupport
dh_scrollkeeper
dh_usrlocal
dh_link
dh_compress
dh_fixperms
}];
my @b=qw{
dh_gencontrol
dh_md5sums
dh_builddeb
};
$sequences{'binary-indep'} = [@{$sequences{install}}, @b];
$sequences{binary} = [@{$sequences{install}}, qw{
dh_strip
dh_makeshlibs
dh_shlibdeps
}, @b];
$sequences{'binary-arch'} = [@{$sequences{binary}}];
# Third-party commands can be listed in the sequences, but should be
# listed here as well. They will not be run if not present.
my %thirdparty=(
dh_pycompat => 1,
dh_pysupport => 1,
);
# Get the sequence of commands to run.
if (! @ARGV) {
error "specify a sequence to run";
}
my $sequence=shift;
if (! exists $sequences{$sequence}) {
error "Unknown sequence $sequence (chose from: ".
join(" ", sort keys %sequences).")";
}
my @sequence=@{$sequences{$sequence}};
# Get the options to pass to commands in the sequence.
# Filter out options intended only for this program.
my @options;
if ($sequence eq 'binary-arch') {
push @options, "-a";
}
elsif ($sequence eq 'binary-indep') {
push @options, "-i";
}
while (@ARGV_orig) {
my $opt=shift @ARGV_orig;
next if $opt eq $sequence;
if ($opt =~ /^--?(after|until|before)$/) {
shift @ARGV_orig;
next;
}
elsif ($opt =~ /^--?(remaining|(after|until|before)=)/) {
next;
}
push @options, $opt;
}
# Figure out at what point in the sequence to start for each package.
my %logged;
my %startpoint;
foreach my $package (@{$dh{DOPACKAGES}}) {
my @log=loadlog($package);
if ($dh{AFTER}) {
# Run commands in the sequence that come after the
# specified command.
$startpoint{$package}=command_pos($dh{AFTER}, @sequence) + 1;
}
elsif ($dh{REMAINING}) {
# Start at the beginning so all remaining commands will get
# run.
$startpoint{$package}=0;
}
else {
# Find the last logged command that is in the sequence, and
# continue with the next command after it. If no logged
# command is in the sequence, we're starting at the beginning..
$startpoint{$package}=0;
COMMAND: foreach my $command (reverse @log) {
foreach my $i (0..$#sequence) {
if ($command eq $sequence[$i]) {
$startpoint{$package}=$i+1;
last COMMAND;
}
}
}
}
}
# Figure out what point in the sequence to go to.
my $stoppoint=$#sequence;
if ($dh{UNTIL}) {
$stoppoint=command_pos($dh{UNTIL}, @sequence);
}
elsif ($dh{BEFORE}) {
$stoppoint=command_pos($dh{BEFORE}, @sequence) - 1;
}
# Now run the commands in the sequence.
foreach my $i (0..$stoppoint) {
# Figure out which packages need to run this command.
my @exclude;
foreach my $package (@{$dh{DOPACKAGES}}) {
if ($startpoint{$package} > $i ||
$logged{$package}{$sequence[$i]}) {
push @exclude, $package;
}
}
if (@exclude eq @{$dh{DOPACKAGES}}) {
# Command already done for all packages.
next;
}
elsif (! @exclude) {
# Run command for all packages.
run($sequence[$i], @options);
}
else {
# Run command for only a subset of packages.
run($sequence[$i], @options,
map { "-N$_" } @exclude);
}
}
sub run {
my $command=shift;
my @options=@_;
# dh_clean -k is a special case
if ($command eq 'dh_clean' && $sequence ne 'clean') {
unshift @options, "-k";
}
# If a third party command is not in /usr/bin, don't try to run it.
if ($thirdparty{$command} && ! -x "/usr/bin/$command") {
return;
}
# The 4 spaces is a kind of half indent.
print " ".escape_shell($command, @options)."\n";
if (! $dh{NO_ACT}) {
my $ret=system($command, @options);
if ($ret >> 8 != 0) {
exit $ret >> 8;
}
elsif ($ret) {
exit 1;
}
}
}
sub loadlog {
my $package=shift;
my $ext=pkgext($package);
my @log;
open(LOG, "<", "debian/${ext}debhelper.log") || return;
while (<LOG>) {
chomp;
push @log, $_;
$logged{$package}{$_}=1;
}
close LOG;
return @log;
}
=head1 SEE ALSO
L<debhelper(7)>
This program is a part of debhelper.
=head1 AUTHOR
Joey Hess <joeyh@debian.org>
=cut
|