The following commit has been merged in the master branch:
commit 69bee88969bc7766a4e2066927f1069b551fba2b
Author: Joachim Breitner <[email protected]>
Date: Sat Jun 13 23:25:23 2009 +0200
Dpkg::Substvars: track unused substitutions and add warning function
This commit adds tracking of used variables in Dpkg::Substvars. It adds
two new methods, no_warn() to disable warnings about one of the
variables, warn_about_unused() to issue warnings (via
Dpkg::ErrorHandling::warning()).
The test suite is extended accordingly.
diff --git a/scripts/Dpkg/Substvars.pm b/scripts/Dpkg/Substvars.pm
index 34295ba..301235c 100644
--- a/scripts/Dpkg/Substvars.pm
+++ b/scripts/Dpkg/Substvars.pm
@@ -50,6 +50,10 @@ and ${dpkg:Upstream-Version}.
Additional substitutions will be read from the $file passed as parameter.
+It keeps track of which substitutions were actually used (only counting
+substvars(), not get()), and warns about unused substvars when asked to. The
+substitutions that are always present are not included in these warnings.
+
=cut
sub new {
@@ -63,6 +67,8 @@ sub new {
"dpkg:Upstream-Version" => $version,
};
$self->{'dpkg:Upstream-Version'} =~ s/-[^-]+$//;
+ $self->{_used} = {};
+ $self->{_used}{$_}++ foreach keys %$self;
bless $self, $class;
if ($arg) {
$self->parse($arg);
@@ -100,9 +106,22 @@ Remove a given substitution.
sub delete {
my ($self, $key) = @_;
+ delete $self->{_used}{$key};
return delete $self->{$key};
}
+=item $s->no_warn($key)
+
+Prevents warnings about a unused substitution, for example if it is provided by
+default.
+
+=cut
+
+sub no_warn {
+ my ($self, $key) = @_;
+ $self->{_used}{$key}++;
+}
+
=item $s->parse($file)
Add new substitutions read from $file.
@@ -133,6 +152,8 @@ sub parse {
Defines ${binary:Version}, ${source:Version} and
${source:Upstream-Version} based on the given version string.
+These will never be warned about when unused.
+
=cut
sub set_version_substvars {
@@ -146,18 +167,23 @@ sub set_version_substvars {
# XXX: Source-Version is now deprecated, remove in the future.
$self->{'Source-Version'} = $version;
+
+ $self->no_warn($_) foreach qw/binary:Version source:Version
source:Upstream-Version Source-Version/;
}
=item $s->set_arch_substvars()
Defines architecture variables: ${Arch}.
+This will never be warned about when unused.
+
=cut
sub set_arch_substvars {
my ($self) = @_;
$self->{'Arch'} = get_host_arch();
+ $self->no_warn('Arch');
}
=item $newstring = $s->substvars($string)
@@ -183,6 +209,7 @@ sub substvars {
$lhs = $PREMATCH; $vn = $1; $rhs = $POSTMATCH;
if (defined($self->{$vn})) {
$v = $lhs . $self->{$vn} . $rhs;
+ $self->{_used}{$vn}++;
$count++;
} else {
warning(_g("unknown substitution variable \${%s}"), $vn);
@@ -192,6 +219,25 @@ sub substvars {
return $v;
}
+=item $s->warn_about_unused()
+
+Issues warning about any variables that were set, but not used
+
+=cut
+
+sub warn_about_unused {
+ my ($self) = @_;
+
+ foreach my $vn (keys %$self) {
+ next if $self->{_used}{$vn};
+ # Empty substitutions variables are ignored on the basis
+ # that they are not required in the current situation
+ # (example: debhelper's misc:Depends in many cases)
+ next if $self->{$vn} eq "";
+ warning(_g("unused substitution variables \${%s}"), $vn);
+ }
+}
+
=back
=head1 AUTHOR
diff --git a/scripts/t/750_Dpkg_Substvars.t b/scripts/t/750_Dpkg_Substvars.t
index 056d83d..061ac7e 100644
--- a/scripts/t/750_Dpkg_Substvars.t
+++ b/scripts/t/750_Dpkg_Substvars.t
@@ -1,6 +1,6 @@
# -*- mode: cperl;-*-
-use Test::More tests => 24;
+use Test::More tests => 26;
use strict;
use warnings;
@@ -72,3 +72,19 @@ is($s->substvars('This is a string with ${rvar}'),
is($s->substvars('Nothing to $ ${substitute here}, is it ${}?, it ${is'),
'Nothing to $ ${substitute here}, is it ${}?, it ${is',
"substvars strange");
+
+# Warnings about unused variables
+$output = '';
+$SIG{'__WARN__'} = sub { $output .= $_[0] };
+$s->warn_about_unused();
+delete $SIG{'__WARN__'};
+is($output, '750_Dpkg_Substvars.t: warning: unused substitution variables
${var2}'."\n",
+ , 'unused variables warnings');
+
+# Disable warnings for a certain variable
+$s->no_warn('var2');
+$output = '';
+$SIG{'__WARN__'} = sub { $output .= $_[0] };
+$s->warn_about_unused();
+delete $SIG{'__WARN__'};
+is($output, '', 'disabled unused variables warnings');
--
dpkg's main repository
--
To UNSUBSCRIBE, email to [email protected]
with a subject of "unsubscribe". Trouble? Contact [email protected]
