/usr/share/lintian/checks/rules.pm is in lintian 2.5.22ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | # rules -- lintian check script -*- perl -*-
# Copyright (C) 2006 Russ Allbery <rra@debian.org>
# Copyright (C) 2005 René van Bevern <rvb@pro-linux.de>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
package Lintian::rules;
use strict;
use warnings;
use autodie;
use Carp qw(croak);
use List::MoreUtils qw(any);
use Lintian::Data;
use Lintian::Tags qw(tag);
use Lintian::Util qw(is_ancestor_of rstrip);
our $PYTHON_DEPEND = 'python | python-dev | python-all | python-all-dev';
our $PYTHON3_DEPEND = 'python3 | python3-dev | python3-all | python3-all-dev';
our $PYTHON2X_DEPEND = 'python2.7 | python2.7-dev';
our $PYTHON3X_DEPEND = join(' | ', map { "python$_ | python$_-dev" } qw(3.2));
our $ANYPYTHON_DEPEND
= "$PYTHON_DEPEND | $PYTHON2X_DEPEND | $PYTHON3_DEPEND | $PYTHON3X_DEPEND";
my $KNOWN_MAKEFILES = Lintian::Data->new('rules/known-makefiles', '\|\|');
my $DEPRECATED_MAKEFILES = Lintian::Data->new('rules/deprecated-makefiles');
my $POLICYRULES = Lintian::Data->new('rules/policy-rules', qr/\s++/);
# forbidden construct in rules
my $BAD_CONSTRUCT_IN_RULES
= Lintian::Data->new('rules/rules-should-not-use', qr/\s*~~\s*/,
sub { return qr/$_[1]/xs });
# Certain build tools must be listed in Build-Depends even if there are no
# arch-specific packages because they're required in order to run the clean
# rule. (See Policy 7.6.) The following is a list of package dependencies;
# regular expressions that, if they match anywhere in the debian/rules file,
# say that this package is allowed (and required) in Build-Depends; and
# optional tags to use for reporting the problem if some information other
# than the default is required.
our @GLOBAL_CLEAN_DEPENDS = (
[ant => qr'^include\s*/usr/share/cdbs/1/rules/ant\.mk'],
[cdbs => qr'^include\s+/usr/share/cdbs/'],
[cdbs => qr'^include\s+/usr/share/R/debian/r-cran\.mk'],
[dbs => qr'^include\s+/usr/share/dbs/'],
['dh-make-php' => qr'^include\s+/usr/share/cdbs/1/class/pear\.mk'],
[debhelper => qr'^include\s+/usr/share/cdbs/1/rules/debhelper\.mk'],
[debhelper => qr'^include\s+/usr/share/R/debian/r-cran\.mk'],
[dpatch => qr'^include\s+/usr/share/cdbs/1/rules/dpatch\.mk'],
['gnome-pkg-tools' => qr'^include\s+/usr/share/gnome-pkg-tools/'],
[quilt => qr'^include\s+/usr/share/cdbs/1/rules/patchsys-quilt\.mk'],
[dpatch => qr'^include\s+/usr/share/dpatch/'],
['mozilla-devscripts' => qr'^include\s+/usr/share/mozilla-devscripts/'],
[quilt => qr'^include\s+/usr/share/quilt/'],
['ruby-pkg-tools' => qr'^include\s+/usr/share/ruby-pkg-tools/1/class/'],
['r-base-dev' => qr'^include\s+/usr/share/R/debian/r-cran\.mk'],
[
$ANYPYTHON_DEPEND => qr'/usr/share/cdbs/1/class/python-distutils\.mk',
'missing-python-build-dependency'
],
);
# A list of packages; regular expressions that, if they match anywhere in the
# debian/rules file, this package must be listed in either Build-Depends or
# Build-Depends-Indep as appropriate; and optional tags as above.
my @GLOBAL_DEPENDS =(
['dh-ocaml, ocaml-nox | ocaml' => qr'^\t\s*dh_ocaml(?:init|doc)\s'],
['python-central' => qr'^DEB_PYTHON_SYSTEM\s*:?=\s*pycentral'],
['python-support' => qr'^DEB_PYTHON_SYSTEM\s*:?=\s*pysupport'],
);
# Similarly, this list of packages, regexes, and optional tags say that if the
# regex matches in one of clean, build-arch, binary-arch, or a rule they
# depend on, this package is allowed (and required) in Build-Depends.
my @RULE_CLEAN_DEPENDS =(
[ant => qr'^\t\s*(\S+=\S+\s+)*ant\s'],
[debhelper => qr'^\t\s*dh_.+'],
['dh-ocaml, ocaml-nox | ocaml' => qr'^\t\s*dh_ocamlinit\s'],
[dpatch => qr'^\t\s*(\S+=\S+\s+)*dpatch\s'],
['po-debconf' => qr'^\t\s*debconf-updatepo\s'],
[$PYTHON_DEPEND => qr'^\t\s*python\s', 'missing-python-build-dependency'],
[
$PYTHON3_DEPEND => qr'^\t\s*python3\s',
'missing-python-build-dependency'
],
[
$ANYPYTHON_DEPEND => qr'\ssetup\.py\b',
'missing-python-build-dependency'
],
[quilt => qr'^\t\s*(\S+=\S+\s+)*quilt\s'],
);
# Rules about required debhelper command ordering. Each command is put into a
# class and the tag is issued if they're called in the wrong order for the
# classes. Unknown commands won't trigger this flag.
my %debhelper_order = (
dh_makeshlibs => 1,
dh_shlibdeps => 2,
dh_installdeb => 2,
dh_gencontrol => 2,
dh_builddeb => 3
);
sub run {
my (undef, undef, $info, undef, $group) = @_;
my $rules = $info->debfiles('rules');
# Policy could be read as allowing debian/rules to be a symlink to
# some other file, and in a native Debian package it could be a
# symlink to a file that we didn't unpack. Warn if it's a symlink
# (dpkg-source does as well) and skip all the tests if we then
# can't read it.
if (-l $rules) {
tag 'debian-rules-is-symlink';
return unless -f $rules and is_ancestor_of($info->debfiles, $rules);
}
my $architecture = $info->field('architecture', '');
my $version = $info->field('version');
# If the version field is missing, we assume a neutral non-native one.
$version = '0-1' unless defined $version;
open(my $rules_fd, '<', $rules);
# Check for required #!/usr/bin/make -f opening line. Allow -r or -e; a
# strict reading of Policy doesn't allow either, but they seem harmless.
my $start = <$rules_fd>;
tag 'debian-rules-not-a-makefile'
unless $start =~ m%^\#!\s*/usr/bin/make\s+-[re]?f[re]?\s*$%;
# Holds which dependencies are required. The keys in %needed and
# %needed_clean are the dependencies; the values are the tags to use or the
# empty string to use the default tag.
my (%needed, %needed_clean);
# Scan debian/rules. We would really like to let make do this for
# us, but unfortunately there doesn't seem to be a way to get make
# to syntax-check and analyze a makefile without running at least
# $(shell) commands.
#
# We skip some of the rule analysis if debian/rules includes any
# other files, since to chase all includes we'd have to have all
# of its build dependencies installed.
local $_;
my @arch_rules = (qr/^clean$/, qr/^binary-arch$/, qr/^build-arch$/);
my @indep_rules = (qr/^build$/, qr/^build-indep$/, qr/^binary-indep$/);
my (@current_targets, %rules_per_target, %debhelper_group);
my %seen;
my $maybe_skipping;
my %variables;
my $uses_makefile_pl = 0;
my $includes = 0;
while (<$rules_fd>) {
while (s,\\$,, and defined(my $cont = <$rules_fd>)) {
$_ .= $cont;
}
my $line = $_;
next if /^\s*\#/;
if (m/^\s*[s-]?include\s+(\S++)/o){
my $makefile = $1;
my $targets = $KNOWN_MAKEFILES->value($makefile);
if (defined $targets){
foreach my $target (split m/\s*+,\s*+/o, $targets){
$seen{$target}++ if $POLICYRULES->known($target);
}
} else {
$includes = 1;
}
if ($DEPRECATED_MAKEFILES->known($makefile)){
tag 'debian-rules-uses-deprecated-makefile', "line $.",
$makefile;
}
}
$uses_makefile_pl = 1 if m/Makefile\.PL/o;
# Check for DH_COMPAT settings outside of any rule, which are now
# deprecated. It's a bit easier structurally to do this here than in
# debhelper.
if (/^\s*(?:export\s+)?DH_COMPAT\s*:?=/ && keys(%seen) == 0) {
tag 'debian-rules-sets-DH_COMPAT', "line $.";
}
# Check for problems that can occur anywhere in debian/rules.
if ( m/^\t\s*-(?:\$[\(\{]MAKE[\}\)]|make)\s.*(?:dist)?clean/s
|| m/^\t\s*(?:\$[\(\{]MAKE[\}\)]|make)\s(?:.*\s)?-(\w*)i.*(?:dist)?clean/s
) {
# Ignore "-C<dir>" (#671537)
if (not $1 or $1 !~ m,^C,) {
tag 'debian-rules-ignores-make-clean-error', "line $.";
}
}
# check generic problem
foreach my $bad_construct ($BAD_CONSTRUCT_IN_RULES->all) {
my $badregex = $BAD_CONSTRUCT_IN_RULES->value($bad_construct);
if ($line =~ m/$badregex/) {
tag $bad_construct, "line $.";
}
}
if ($uses_makefile_pl && m/install.*PREFIX/s && !/DESTDIR/) {
tag 'debian-rules-makemaker-prefix-is-deprecated', "line $.";
}
# General assignment - save the variable
if (/^\s*(?:\S+\s+)*?(\S+)\s*([:\?\+])?=\s*(.*+)?$/so) {
# This is far too simple from a theoretical PoV, but should do
# rather well.
my ($var, $atype, $value) = ($1, $2, $3);
$variables{$var} = $value;
}
# Keep track of whether this portion of debian/rules may be optional
if (/^ifn?(?:eq|def)\s/) {
$maybe_skipping++;
} elsif (/^endif\s/) {
$maybe_skipping--;
}
# Check for strings anywhere in debian/rules that have implications for
# our dependencies.
for my $rule (@GLOBAL_CLEAN_DEPENDS) {
if (/$rule->[1]/ and not $maybe_skipping) {
$needed_clean{$rule->[0]}
= $rule->[2] || $needed_clean{$rule->[0]} || '';
}
}
for my $rule (@GLOBAL_DEPENDS) {
if (/$rule->[1]/ && !$maybe_skipping) {
$needed{$rule->[0]} = $rule->[2] || $needed{$rule->[0]} || '';
}
}
# Listing a rule as a dependency of .PHONY is sufficient to make it
# present for the purposes of GNU make and therefore the Policy
# requirement.
if (/^(?:[^:]+\s)?\.PHONY(?:\s[^:]+)?:(.+)/s) {
my @targets = split(' ', $1);
local $_;
for (@targets) {
# Is it $(VAR) ?
if (m/^\$[\(\{]([^\)\}]++)[\)\}]$/) {
my $name = $1;
my $val = $variables{$name};
if ($val) {
# we think we know what it will expand to - note
# we ought to "delay" it was a "=" variable rather
# than ":=" or "+=".
for (split m/\s++/o, rstrip($val)) {
$seen{$_}++ if $POLICYRULES->known($_);
}
last;
}
# We don't know, so just mark the target as seen.
}
$seen{$_}++ if $POLICYRULES->known($_);
}
next; #.PHONY implies the rest will not match
}
if (!/^ifn?(?:eq|def)\s/ && m/^([^\s:][^:]*):+(.*)/s) {
my ($target_names, $target_dependencies) = ($1, $2);
@current_targets = split ' ', $target_names;
my @depends = map {
$_ = quotemeta $_;
s/\\\$\\\([^\):]+\\:([^=]+)\\=([^\)]+)\1\\\)/$2.*/g;
qr/^$_$/;
} split(' ', $target_dependencies);
for my $target (@current_targets) {
if ($target =~ m/%/o) {
my $pattern = quotemeta $target;
$pattern =~ s/\\%/.*/g;
for my $rulebypolicy ($POLICYRULES->all) {
$seen{$rulebypolicy}++ if $rulebypolicy =~ m/$pattern/;
}
} else {
# Is it $(VAR) ?
if ($target =~ m/^\$[\(\{]([^\)\}]++)[\)\}]$/) {
my $name = $1;
my $val = $variables{$name};
if ($val) {
# we think we know what it will expand to - note
# we ought to "delay" it was a "=" variable rather
# than ":=" or "+=".
local $_;
for (split m/\s++/o, rstrip($val)) {
$seen{$_}++ if $POLICYRULES->known($_);
}
last;
}
# We don't know, so just mark the target as seen.
}
$seen{$target}++ if $POLICYRULES->known($target);
}
if (any { $target =~ /$_/ } @arch_rules) {
push(@arch_rules, @depends);
}
}
undef %debhelper_group;
} elsif (/^define /) {
# We don't want to think the body of the define is part of
# the previous rule or we'll get false positives on tags
# like binary-arch-rules-but-pkg-is-arch-indep. Treat a
# define as the end of the current rule, although that
# isn't very accurate either.
@current_targets = ();
} else {
# If we have non-empty, non-comment lines, store them for
# all current targets and check whether debhelper programs
# are called in a reasonable order.
if (m/^\s+[^\#]/) {
my ($arch, $indep) = (0, 0);
for my $target (@current_targets) {
$rules_per_target{$target} ||= [];
push @{$rules_per_target{$target}}, $_;
$arch = 1 if (any { $target =~ /$_/ } @arch_rules);
$indep = 1 if (any { $target =~ /$_/ } @indep_rules);
$indep = 1 if $target eq '%';
$indep = 1 if $target =~ /^override_/;
}
if (not $maybe_skipping and ($arch or $indep)) {
my $table = \%needed;
$table = \%needed_clean if $arch;
for my $rule (@RULE_CLEAN_DEPENDS) {
my ($dep, $pattern, $tagname) = @$rule;
next unless /$pattern/;
$table->{$dep} = $tagname || $table->{$dep} || '';
}
}
if (m/^\s+(dh_\S+)\b/ and $debhelper_order{$1}) {
my $command = $1;
my ($package) = /\s(?:-p|--package=)(\S+)/;
$package ||= '';
my $group = $debhelper_order{$command};
$debhelper_group{$package} ||= 0;
if ($group < $debhelper_group{$package}) {
tag 'debian-rules-calls-debhelper-in-odd-order',
$command, "(line $.)";
} else {
$debhelper_group{$package} = $group;
}
}
}
}
}
close($rules_fd);
unless ($includes) {
my $rec_allindep = 0;
# Make sure all the required rules were seen.
for my $target ($POLICYRULES->all) {
unless ($seen{$target}) {
my $typerule = $POLICYRULES->value($target);
if($typerule eq 'required') {
tag 'debian-rules-missing-required-target', $target;
} elsif ($typerule eq 'recommended_allindep') {
tag 'debian-rules-missing-recommended-target', $target;
$rec_allindep++;
} elsif ($typerule eq 'goodpractice_dfsg') {
if ($version =~ /(dfsg|debian|ds)/) {
tag 'debian-rules-missing-good-practice-target-dfsg',
$target;
}
} else {
$typerule ||= '<N/A>';
croak(
join(' ',
'unknown type of policy rules:',
"$typerule (target: $target)"));
}
}
}
if ($rec_allindep) {
my $all = 0;
my $notall = 0;
foreach my $p ($group->get_processables) {
next if $p->pkg_type eq 'source' or $p->pkg_type eq 'changes';
$all++ if $p->pkg_arch eq 'all';
$notall++ if $p->pkg_arch ne 'all';
}
tag 'package-would-benefit-from-build-arch-targets'
if $all && $notall;
}
}
# Make sure we have no content for binary-arch if we are arch-indep:
$rules_per_target{'binary-arch'} ||= [];
if ($architecture eq 'all' && scalar @{$rules_per_target{'binary-arch'}}) {
my $nonempty = 0;
foreach (@{$rules_per_target{'binary-arch'}}) {
# dh binary-arch is actually a no-op if there is no
# Architecture: any package in the control file
unless (m/^\s*dh\s+(?:binary-arch|\$\@)/) {
$nonempty = 1;
}
}
tag 'binary-arch-rules-but-pkg-is-arch-indep' if $nonempty;
}
# Make sure that all the required build dependencies are there. Don't
# issue missing-build-dependency errors for debhelper, since there's
# another test that does that and it would just be a duplicate.
my $build_regular = $info->relation('build-depends');
my $build_indep = $info->relation('build-depends-indep');
for my $package (keys %needed_clean) {
delete $needed{$package};
my $tag = $needed_clean{$package} || 'missing-build-dependency';
unless ($build_regular->implies($package)) {
if ($build_indep->implies($package)) {
tag 'clean-should-be-satisfied-by-build-depends', $package;
} else {
if ($tag eq 'missing-build-dependency') {
tag $tag, $package if $package ne 'debhelper';
} else {
tag $tag;
}
}
}
}
my $noarch = $info->relation_noarch('build-depends-all');
for my $package (keys %needed) {
my $tag = $needed{$package} || 'missing-build-dependency';
unless ($noarch->implies($package)) {
if ($tag eq 'missing-build-dependency') {
tag $tag, $package;
} else {
tag $tag;
}
}
}
return;
}
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|