pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/pkgtools/pkglint Added type checking for Makefile vari...
details: https://anonhg.NetBSD.org/pkgsrc/rev/8c872ff98e2b
branches: trunk
changeset: 488926:8c872ff98e2b
user: rillig <rillig%pkgsrc.org@localhost>
date: Sat Feb 12 10:59:20 2005 +0000
description:
Added type checking for Makefile variables. The typechecking is
experimental and has been announced on tech-pkg to make the package
developers aware of it.
diffstat:
pkgtools/pkglint/Makefile | 8 ++-
pkgtools/pkglint/files/makevars.map | 57 +++++++++++++++++++++++++
pkgtools/pkglint/files/pkglint.pl | 82 ++++++++++++++++++++++++++++++++++++-
3 files changed, 142 insertions(+), 5 deletions(-)
diffs (247 lines):
diff -r 9398f22f12a9 -r 8c872ff98e2b pkgtools/pkglint/Makefile
--- a/pkgtools/pkglint/Makefile Sat Feb 12 07:58:53 2005 +0000
+++ b/pkgtools/pkglint/Makefile Sat Feb 12 10:59:20 2005 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.215 2005/02/11 17:01:29 rillig Exp $
+# $NetBSD: Makefile,v 1.216 2005/02/12 10:59:20 rillig Exp $
#
-DISTNAME= pkglint-4.01
+DISTNAME= pkglint-4.02
CATEGORIES= pkgtools devel
MASTER_SITES= # empty
DISTFILES= # empty
@@ -24,7 +24,7 @@
DISTVER= ${DISTNAME:S/pkglint-//}
-INSTALLATION_DIRS= bin man/cat1 man/man1
+INSTALLATION_DIRS= bin man/cat1 man/man1 share/pkglint
SUBST_CLASSES+= pkglint
SUBST_STAGE.pkglint= pre-build
@@ -36,6 +36,7 @@
SUBST_SED.pkglint+= -e 's|@DISTVER@|${DISTVER}|g'
SUBST_SED.pkglint+= -e 's|@MAKE@|${MAKE}|g'
SUBST_SED.pkglint+= -e 's|@PERL@|${PERL5}|g'
+SUBST_SED.pkglint+= -e 's|@DATADIR@|${PREFIX}/share/pkglint|g'
.include "../../mk/bsd.prefs.mk"
@@ -61,5 +62,6 @@
${INSTALL_MAN} ${WRKSRC}/lintpkgsrc.1 ${PREFIX}/man/man1
${INSTALL_MAN} ${WRKSRC}/pkglint.0 ${PREFIX}/man/cat1
${INSTALL_MAN} ${WRKSRC}/pkglint.1 ${PREFIX}/man/man1
+ ${INSTALL_DATA} ${FILESDIR}/makevars.map ${PREFIX}/share/pkglint/
.include "../../mk/bsd.pkg.mk"
diff -r 9398f22f12a9 -r 8c872ff98e2b pkgtools/pkglint/files/makevars.map
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/pkgtools/pkglint/files/makevars.map Sat Feb 12 10:59:20 2005 +0000
@@ -0,0 +1,57 @@
+# $NetBSD: makevars.map,v 1.1 2005/02/12 10:59:21 rillig Exp $
+#
+
+# This file tries to guess the type of some variables, according to their
+# current use in pkgsrc. The type Boolean is nicer than Yes_Or_Undefined,
+# but most variables are only checked with defined(...) and not with an
+# additional !empty(...:M[Yy][Ee][Ss]). So we have to check both.
+#
+# Beware: For the type Yes_Or_Undefined, even the value NO means YES.
+#
+# The type One_Of(...) is just used for explanation. It cannot yet be
+# checked by pkglint.
+
+# some variables from mk/defaults/mk.conf, 1.27
+
+MANZ Yes_Or_Undefined
+MKCRYPTO Boolean
+USETBL Yes_Or_Undefined
+#ABI One_Of(32 64)
+IGNORE_RECOMMENDED Boolean
+PKG_REGISTER_SHELLS Boolean
+USE_XPKGWEDGE Boolean
+LIBTOOLIZE_PLIST Boolean
+EXTRACT_USING_PAX Yes_Or_Undefined
+SETGIDGAME Boolean
+
+#USE_CRYPTO One_Of(YES NO)
+USE_CUPS Yes_Or_Undefined
+#USE_DB2 One_Of(YES NO) ; weird (see mail/sendmail812)
+USE_ESOUND Boolean
+USE_GIF Yes_Or_Undefined
+USE_I586 Boolean
+#USE_IDEA One_Of(YES NO)
+USE_INET6 Boolean
+USE_INN Yes_Or_Undefined
+USE_MMX Boolean
+#USE_OPENLDAP One_Of(YES NO)
+USE_OSS Yes_Or_Undefined
+USE_PAM Boolean
+#USE_SASL One_Of(YES NO)
+#USE_SASL2 One_Of(YES NO)
+#USE_SJ3 One_Of(YES NO)
+#USE_SOCKS One_Of(4 5)
+#USE_WNN4 One_Of(YES NO)
+USE_XFACE Boolean
+
+# some variables found in package Makefiles
+
+GNU_CONFIGURE Yes_Or_Undefined
+HOMEPAGE URL
+MAINTAINER Mail_Address
+NO_BUILDLINK Yes_Or_Undefined
+NO_CHECKSUM Yes_Or_Undefined
+NO_CONFIGURE Yes_Or_Undefined
+#USE_PERL5 One_Of(build run)
+USE_X11 Yes_Or_Undefined
+MANZ Yes_Or_Undefined
diff -r 9398f22f12a9 -r 8c872ff98e2b pkgtools/pkglint/files/pkglint.pl
--- a/pkgtools/pkglint/files/pkglint.pl Sat Feb 12 07:58:53 2005 +0000
+++ b/pkgtools/pkglint/files/pkglint.pl Sat Feb 12 10:59:20 2005 +0000
@@ -11,7 +11,7 @@
# Freely redistributable. Absolutely no warranty.
#
# From Id: portlint.pl,v 1.64 1998/02/28 02:34:05 itojun Exp
-# $NetBSD: pkglint.pl,v 1.127 2005/02/11 17:01:29 rillig Exp $
+# $NetBSD: pkglint.pl,v 1.128 2005/02/12 10:59:21 rillig Exp $
#
# This version contains lots of changes necessary for NetBSD packages
# done by Hubert Feyrer <hubertf%netbsd.org@localhost>,
@@ -232,6 +232,7 @@
my $conf_localbase = '@PREFIX@';
my $conf_distver = '@DISTVER@';
my $conf_make = '@MAKE@';
+my $conf_datadir = '@DATADIR@';
# Command Line Options
my $opt_committer = true;
@@ -271,12 +272,14 @@
my $opt_warn_directcmd = true;
my $opt_warn_paren = true;
my $opt_warn_workdir = true;
+my $opt_warn_types = true;
my (%warnings) = (
"patches" => [\$opt_warn_patches, "warn on non-optimal patch files"],
"exec" => [\$opt_warn_exec, "warn if source files are executable"],
"absname" => [\$opt_warn_absname, "warn about use of absolute file names"],
"directcmd" => [\$opt_warn_directcmd, "warn about use of direct command names instead of Make variables"],
"paren" => [\$opt_warn_paren, "warn about usa of \$(VAR) instead of \${VAR} in Makefiles"],
+ "types" => [\$opt_warn_types, "do some simple type checking in Makefiles"],
"workdir" => [\$opt_warn_workdir, "warn that work* should not be committed into CVS"],
);
@@ -284,6 +287,10 @@
my $regex_rcsidstr = qr"\$($conf_rcsidstr)(?::[^\$]*|)\$";
my $regex_known_rcs_tag = qr"\$(Author|Date|Header|Id|Locker|Log|Name|RCSfile|Revision|Source|State|$conf_rcsidstr)(?::[^\$]*?|)\$";
my $regex_validchars = qr"[\011\040-\176]";
+my $regex_boolean = qr"^(?:YES|yes|NO|no)$";
+my $regex_yes_or_undef = qr"^(?:YES|yes)$";
+my $regex_mail_address = qr"^[-\w\d_.]+\@[-\w\d.]+$";
+my $regex_url = qr"^(?:http://|ftp://|#)"; # allow empty URLs
# Global variables that should be eliminated by the next refactoring.
my %definesfound = ();
@@ -301,6 +308,7 @@
my %seen_Makefile_include = ();
my %predefined;
my $pkgname = "";
+my %make_vars_typemap = ();
# these subroutines return C<true> if the checking succeeded (that includes
# errors in the file) and C<false> if the file could not be checked.
@@ -449,8 +457,28 @@
return true;
}
+sub load_make_vars_typemap() {
+ my ($lines) = (load_file("${conf_datadir}/makevars.map"));
+ if (!$lines) {
+ return false;
+ }
+ foreach my $line (@$lines) {
+ if ($line->text =~ qr"^(?:#.*|\s*)$") {
+ # ignore empty and comment lines
+ } elsif ($line->text =~ qr"^([\w\d_.]+)\s+([\w_]+)$") {
+ $make_vars_typemap{$1} = $2;
+ } else {
+ log_error($line->file, $line->lineno, "unknown line format");
+ }
+ }
+ return true;
+}
+
sub main() {
parse_command_line();
+ if ($opt_warn_types) {
+ load_make_vars_typemap();
+ }
log_info(NO_FILE, NO_LINE_NUMBER, "pkgsrcdir: $conf_pkgsrcdir");
log_info(NO_FILE, NO_LINE_NUMBER, "rcsidstr: $conf_rcsidstr");
@@ -1102,6 +1130,52 @@
return $contents;
}
+sub check_make_variable_definition($) {
+ my ($line) = @_;
+ if ($line->text =~ qr"([A-Z_a-z0-9.]+)\s*(=|\?=|\+=)\s*(.*)") {
+ my ($varname, $op, $value) = ($1, $2, $3);
+ if ($value =~ qr"\$") {
+ # ignore values that contain other variables
+ } elsif (exists($make_vars_typemap{$varname})) {
+ my ($type) = ($make_vars_typemap{$varname});
+ if ($type eq "Boolean") {
+ if ($value !~ $regex_boolean) {
+ log_warning($line->file, $line->lineno, "$varname should be set to YES, yes, NO, or no.");
+ }
+ } elsif ($type eq "Yes_Or_Undefined") {
+ if ($value !~ $regex_yes_or_undef) {
+ log_warning($line->file, $line->lineno, "$varname should be set to YES or yes");
+ }
+ } elsif ($type eq "Mail_Address") {
+ if ($value !~ $regex_mail_address) {
+ log_warning($line->file, $line->lineno, "\"$value\" is not a valid mail address");
+ }
+ } elsif ($type eq "URL") {
+ if ($value !~ $regex_url) {
+ log_warning($line->file, $line->lineno, "\"$value\" is not a valid URL");
+ }
+ } else {
+ log_error($line->file, $line->lineno, "internal error: type $type unknown");
+ }
+ }
+ }
+ return true;
+}
+
+sub check_Makefile_variable_definitions($) {
+ my ($fname) = @_;
+ my ($lines) = load_file($fname);
+ if (!$lines) {
+ log_error($fname, NO_LINE_NUMBER, "Could not open");
+ return false;
+ } else {
+ foreach my $line (@$lines) {
+ check_make_variable_definition($line);
+ }
+ }
+ return true;
+}
+
sub checkfile_Makefile($) {
my ($file) = @_;
my ($fname) = ("$opt_packagedir/$file");
@@ -1893,7 +1967,11 @@
"discouraged. redefine \"do-$1\" instead.");
}
- return true;
+ if ($opt_warn_types) {
+ return check_Makefile_variable_definitions($fname);
+ } else {
+ return true;
+ }
}
sub checkextra($$) {
Home |
Main Index |
Thread Index |
Old Index