X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=dh;h=130d647ead2207734627eadf5859899f9a63614b;hb=edbe1cf7d625f9cc3db5c266db4845592e588569;hp=8327b64a31acd40be9bf5173058bf8589241f9b5;hpb=d3cb133cd8399efa737f86067c490a3bf520f3e9;p=debhelper.git diff --git a/dh b/dh index 8327b64..130d647 100755 --- a/dh +++ b/dh @@ -11,21 +11,23 @@ use Debian::Debhelper::Dh_Lib; =head1 SYNOPSIS -B sequence [B<--with> I[,I,...]] [B<--list>] [B<--until> I] [B<--before> I] [B<--after> I] [B<--remaining>] [S>] +B I [B<--with> I[B<,>I ...]] [B<--list>] [B<--until> I] [B<--before> I] [B<--after> I] [B<--remaining>] [S>] =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". +B runs a sequence of debhelper commands. The supported Is +correspond to the targets of a F file: B, +B, B, B, B, B, +B, B, B, and B. -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. +Commands in the B, B and B +sequences are passed the B<-i> option to ensure they only work on +architecture independent packages, and commands in the B, +B and B sequences are passed the B<-a> +option to ensure they only work on architecture dependent packages. -If debian/rules contains a target with a name like "override_I", -then when it would normally run I, dh will instead call that +If F contains a target with a name like BI, +then when it would normally run I, B will instead call that target. The override target can then run the command with additional options, or run entirely different commands instead. See examples below. (Note that to use this feature, you should Build-Depend on debhelper 7.0.50 or above.) @@ -34,18 +36,18 @@ use this feature, you should Build-Depend on debhelper 7.0.50 or above.) =over 4 -=item B<--with> I[,I,...] +=item B<--with> I[B<,>I ...] Add the debhelper commands specified by the given addon to appropriate places in the sequence of commands that is run. This option can be repeated more than once, or multiple addons can be listed, separated by commas. This is used when there is a third-party package that provides -debhelper commands. See the PROGRAMMING file for documentation about +debhelper commands. See the F file for documentation about the sequence addon interface. =item B<--without> I -The inverse of --with, disables using the given addon. +The inverse of B<--with>, disables using the given addon. =item B<--list>, B<-l> @@ -73,8 +75,8 @@ Prints commands that would run for a given sequence, but does not run them. =back -All other 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 +All other options passed to B are passed on to each command it runs. This +can be used to set an option like B<-v> or B<-X> or B<-N>, as well as for more specialised options. In the above options, I can be a full name of a debhelper command, or @@ -160,14 +162,24 @@ after a particular debhelper command is run. dh_fixperms chmod 4755 debian/foo/usr/bin/foo -If your package is a python package, dh will use dh_pysupport by -default. This is how to use dh_pycentral instead. +Python tools are not run by dh by default, due to the continual change +in that area. (Before compatability level v9, dh does run B.) +Here is how to use B. #!/usr/bin/make -f %: - dh $@ --with python-central + dh $@ --with python2 -Here is how to force use of perl's Module::Build build system, +If your package uses autotools and you want to freshen F and +F with newer versions from the B package +at build time, you can use some commands provided in B +that automate it, like this. + + #!/usr/bin/make -f + %: + dh $@ --with autotools_dev + +Here is how to force use of Perl's B build system, which can be necessary if debhelper wrongly detects that the package uses MakeMaker. @@ -175,14 +187,14 @@ uses MakeMaker. %: dh $@ --buildsystem=perl_build -To patch your package using quilt, you can tell dh to use quilt's dh +To patch your package using quilt, you can tell B to use quilt's B sequence addons like this: #!/usr/bin/make -f %: dh $@ --with quilt -Here is an example of overriding where the dh_auto_* commands find +Here is an example of overriding where the BI<*> commands find the package's source, for a package where the source is located in a subdirectory. @@ -190,21 +202,21 @@ subdirectory. %: dh $@ --sourcedirectory=src -And here is an example of how to tell the dh_auto_* commands to build -in a subdirectory, which will be removed on clean. +And here is an example of how to tell the BI<*> commands to build +in a subdirectory, which will be removed on B. #!/usr/bin/make -f %: dh $@ --builddirectory=build If your package can be built in parallel, you can support parallel building -as follows. Then I will work. +as follows. Then B will work. #!/usr/bin/make -f %: dh $@ --parallel -Here is a way to prevent dh from running several commands that you don't +Here is a way to prevent B from running several commands that you don't want it to run, by defining empty override targets for each command. #!/usr/bin/make -f @@ -224,42 +236,53 @@ L to test what is being built. For example: override_dh_fixperms: dh_fixperms - ifneq (,$(findstring foo, $(shell dh_listpackages))) + ifneq (,$(filter foo, $(shell dh_listpackages))) chmod 4755 debian/foo/usr/bin/foo endif Finally, remember that you are not limited to using override targets in the -rules file when using dh. You can also explicitly define any of the regular +rules file when using B. You can also explicitly define any of the regular rules file targets when it makes sense to do so. A common reason to do this -is if your package needs different build-arch and build-indep targets. For -example, a package with a long document build process can put it in -build-indep to avoid build daemons redundantly building the documentation. +is when your package needs different B and B targets. +For example, a package with a long document build process can put it in +B. #!/usr/bin/make -f %: dh $@ - build: build-arch build-indep ; build-indep: $(MAKE) docs build-arch: $(MAKE) bins +Note that in the example above, dh will arrange for "debian/rules build" +to call your build-indep and build-arch targets. You do not need to +explicitly define the dependencies in the rules file when using dh with +compatibility level v9. This example would be more complicated with +earlier compatibility levels. + =head1 INTERNALS -If you're curious about dh's internals, here's how it works under the hood. +If you're curious about B's internals, here's how it works under the hood. Each debhelper command will record when it's successfully run in -debian/package.debhelper.log. (Which dh_clean deletes.) So dh can tell +F. (Which B deletes.) So B 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 +Each time B 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. -dh uses the DH_INTERNAL_OPTIONS environment variable to pass information +A sequence can also run dependent targets in debian/rules. For +example, the "binary" sequence runs the "install" target. + +B sets environment variables listed by B, unless +they are already set. It supports DEB_BUILD_OPTIONS=noopt too. + +B uses the B environment variable to pass information through to debhelper commands that are run inside override targets. The contents (and indeed, existence) of this environment variable, as the name might suggest, is subject to change at any time. @@ -269,9 +292,11 @@ might suggest, is subject to change at any time. # Stash this away before init modifies it. my @ARGV_orig=@ARGV; -# python-support is enabled by default, at least for now -# (and comes first so python-central loads later and can disable it). -unshift @ARGV, "--with=python-support"; +if (compat(8)) { + # python-support was enabled by default before v9. + # (and comes first so python-central loads later and can disable it). + unshift @ARGV, "--with=python-support"; +} init(options => { "until=s" => \$dh{UNTIL}, @@ -296,7 +321,7 @@ init(options => { bundling => 0, ); inhibit_log(); - +set_buildflags(); # If make is using a jobserver, but it is not available # to this process, clean out MAKEFLAGS. This avoids @@ -305,20 +330,53 @@ if (is_make_jobserver_unavailable()) { clean_jobserver_makeflags(); } +# Process the sequence parameter. +my $sequence; +if (! compat(7)) { + # From v8, the sequence is the very first parameter. + $sequence=shift @ARGV_orig; + if ($sequence=~/^-/) { + error "Unknown sequence $sequence (options should not come before the sequence)"; + } +} +else { + # Before v8, the sequence could be at any position in the parameters, + # so was what was left after parsing. + $sequence=shift; + if (defined $sequence) { + @ARGV_orig=grep { $_ ne $sequence } @ARGV_orig; + } +} +if (! defined $sequence) { + error "specify a sequence to run"; +} +# make -B causes the rules file to be run as a target. +# Also support completly empty override targets. +# Note: it's not safe to use rules_explicit_target before this check, +# since it causes dh to be run. +my $dummy_target="debhelper-fail-me"; +if ($sequence eq 'debian/rules' || + $sequence =~ /^override_dh_/ || + $sequence eq $dummy_target) { + exit 0; +} + + # Definitions of sequences. my %sequences; -$sequences{build} = [qw{ +my @bd_minimal = qw{ + dh_testdir +}; +my @bd = 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{ +}; +my @i_minimal = qw{ + dh_testroot +}; +my @i = qw{ dh_testroot dh_prep dh_installdirs @@ -347,7 +405,9 @@ $sequences{install} = [@{$sequences{build}}, qw{ dh_installudev dh_installwm dh_installxfonts + dh_installgsettings dh_bugfiles + dh_ucf dh_lintian dh_gconf dh_icons @@ -357,20 +417,60 @@ $sequences{install} = [@{$sequences{build}}, qw{ dh_link dh_compress dh_fixperms -}]; +}; +my @ba=qw{ + dh_strip + dh_makeshlibs + dh_shlibdeps +}; my @b=qw{ dh_installdeb 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}}]; +$sequences{clean} = [qw{ + dh_testdir + dh_auto_clean + dh_clean +}]; +$sequences{'build-indep'} = [@bd]; +$sequences{'build-arch'} = [@bd]; +if (! compat(8)) { + # From v9, sequences take standard rules targets into account. + if (rules_explicit_target('build-arch') || + rules_explicit_target('build-indep')) { + # run sequences separately + $sequences{build} = [@bd_minimal, rules("build-arch"), rules("build-indep")]; + } + else { + # run standard sequence (this is faster) + $sequences{build} = [@bd]; + } + $sequences{'install-indep'} = [rules("build-indep"), @i]; + $sequences{'install-arch'} = [rules("build-arch"), @i]; + if (rules_explicit_target('install-arch') || + rules_explicit_target('install-indep')) { + # run sequences separately + $sequences{'install'} = [rules("build"), @i_minimal, rules("install-arch"), rules("install-indep")]; + } + else { + # run standard sequence (this is faster) + $sequences{'install'} = [rules("build"), @i, rules("install-arch"), rules("install-indep")]; + } + $sequences{'binary-indep'} = [rules("install-indep"), @b]; + $sequences{'binary-arch'} = [rules("install-arch"), @ba, @b]; + $sequences{binary} = [rules("install"), rules("binary-arch"), rules("binary-indep")]; +} +else { + $sequences{build} = [@bd]; + $sequences{'install'} = [@{$sequences{build}}, @i]; + $sequences{'install-indep'} = [@{$sequences{'build-indep'}}, @i]; + $sequences{'install-arch'} = [@{$sequences{'build-arch'}}, @i]; + $sequences{binary} = [@{$sequences{install}}, @ba, @b]; + $sequences{'binary-indep'} = [@{$sequences{'install-indep'}}, @b]; + $sequences{'binary-arch'} = [@{$sequences{'install-arch'}}, @ba, @b]; +} # Additional command options my %command_opts; @@ -459,6 +559,7 @@ sub list_addons { exit 0; } +# Load addons, which can modify sequences. foreach my $addon (@{$dh{WITH}}) { my $mod="Debian::Debhelper::Sequence::$addon"; $mod=~s/-/_/g; @@ -468,36 +569,11 @@ foreach my $addon (@{$dh{WITH}}) { } } -my $sequence; -if (! compat(7)) { - # From v8, the sequence is the very first parameter. - $sequence=shift @ARGV_orig; - if ($sequence=~/^-/) { - error "Unknown sequence $sequence (options should not come before the sequence)"; - } -} -else { - # Before v8, the sequence could be at any position in the parameters, - # so was what was left after parsing. - $sequence=shift; - if (defined $sequence) { - @ARGV_orig=grep { $_ ne $sequence } @ARGV_orig; - } -} -if (! defined $sequence) { - error "specify a sequence to run"; -} -if ($sequence eq 'debian/rules' || - $sequence =~ /^override_dh_/) { - # make -B causes the rules file to be run as a target. - # Also support completly empty override targets. - exit 0; -} -elsif (! exists $sequences{$sequence}) { +if (! exists $sequences{$sequence}) { error "Unknown sequence $sequence (choose from: ". join(" ", sort keys %sequences).")"; } -my @sequence=@{$sequences{$sequence}}; +my @sequence=optimize_sequence(@{$sequences{$sequence}}); # The list of all packages that can be acted on. my @packages=@{$dh{DOPACKAGES}}; @@ -505,14 +581,18 @@ my @packages=@{$dh{DOPACKAGES}}; # 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') { +if ($sequence eq 'build-arch' || + $sequence eq 'install-arch' || + $sequence eq 'binary-arch') { push @options, "-a"; # as an optimisation, remove from the list any packages # that are not arch dependent my %arch_packages = map { $_ => 1 } getpackages("arch"); @packages = grep { $arch_packages{$_} } @packages; } -elsif ($sequence eq 'binary-indep') { +elsif ($sequence eq 'build-indep' || + $sequence eq 'install-indep' || + $sequence eq 'binary-indep') { push @options, "-i"; # ditto optimisation for arch indep my %indep_packages = map { $_ => 1 } getpackages("indep"); @@ -619,13 +699,26 @@ sub run { # run them instead of running the command directly. my $override_command; my $has_explicit_target = rules_explicit_target("override_".$command); - if (defined $has_explicit_target) { + + my $rules_target = rules_target($command); + if (defined $rules_target) { + # Don't pass DH_ environment variables, since this is + # a fresh invocation of debian/rules and any sub-dh + # commands. + $override_command=$command; + delete $ENV{DH_INTERNAL_OPTIONS}; + delete $ENV{DH_INTERNAL_OVERRIDE}; + $command="debian/rules"; + @options=$rules_target; + } + elsif (defined $has_explicit_target) { $override_command=$command; # Check if target isn't noop if ($has_explicit_target) { # This passes the options through to commands called # inside the target. $ENV{DH_INTERNAL_OPTIONS}=join("\x1e", @options); + $ENV{DH_INTERNAL_OVERRIDE}=$command; $command="debian/rules"; @options="override_".$override_command; } @@ -646,10 +739,11 @@ sub run { else { print " ", "# Skipping ", $override_command, " - empty override", "\n"; } - + if (! $dh{NO_ACT}) { if (defined $command) { my $ret=system($command, @options); + if ($ret >> 8 != 0) { exit $ret >> 8; } @@ -659,21 +753,63 @@ sub run { } if (defined $override_command) { - delete $ENV{DH_INTERNAL_OPTIONS}; - # Need to handle logging for overriden commands here, - # because the actual debhelper command may not have - # been run by the rules file target. + # Update log for overridden command now that it has + # finished successfully. # (But avoid logging for dh_clean since it removes # the log earlier.) if ($override_command ne 'dh_clean') { my %packages=map { $_ => 1 } @packages; map { delete $packages{$_} } @exclude; write_log($override_command, keys %packages); + commit_override_log(keys %packages); } + + delete $ENV{DH_INTERNAL_OPTIONS}; + delete $ENV{DH_INTERNAL_OVERRIDE}; } } } +sub optimize_sequence { + my @sequence; + my %seen; + my $add=sub { + # commands can appear multiple times when sequences are + # inlined together; only the first should be needed + my $command=shift; + if (! $seen{$command}) { + $seen{$command}=1; + push @sequence, $command; + } + }; + foreach my $command (@_) { + my $rules_target=rules_target($command); + if (defined $rules_target && + ! defined rules_explicit_target($rules_target)) { + # inline the sequence for this implicit target + $add->($_) foreach optimize_sequence(@{$sequences{$rules_target}}); + } + else { + $add->($command); + } + } + return @sequence; +} + +sub rules_target { + my $command=shift; + if ($command =~ /^debian\/rules\s+(.*)/) { + return $1 + } + else { + return undef; + } +} + +sub rules { + return "debian/rules ".join(" ", @_); +} + { my %targets; my $rules_parsed; @@ -689,7 +825,7 @@ sub rules_explicit_target { my $processing_targets = 0; my $not_a_target = 0; my $current_target; - open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules debhelper-fail-me 2>/dev/null |"); + open(MAKE, "LC_ALL=C make -Rrnpsf debian/rules $dummy_target 2>/dev/null |"); while () { if ($processing_targets) { if (/^# Not a target:/) {