pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/pkgtools/pkglint Updated pkglint to 4.46.1.
details: https://anonhg.NetBSD.org/pkgsrc/rev/3720dab5a79f
branches: trunk
changeset: 503677:3720dab5a79f
user: rillig <rillig%pkgsrc.org@localhost>
date: Thu Nov 24 21:51:10 2005 +0000
description:
Updated pkglint to 4.46.1.
- Marked ALLFILES as deprecated.
- Degraded white-space warnings to notes.
- Added many explanations for the diagnostics.
diffstat:
pkgtools/pkglint/Makefile | 4 +-
pkgtools/pkglint/files/deprecated.map | 3 +-
pkgtools/pkglint/files/pkglint.pl | 79 ++++++++++++++++++++++++++++------
3 files changed, 68 insertions(+), 18 deletions(-)
diffs (256 lines):
diff -r cc61d5ec3678 -r 3720dab5a79f pkgtools/pkglint/Makefile
--- a/pkgtools/pkglint/Makefile Thu Nov 24 20:33:38 2005 +0000
+++ b/pkgtools/pkglint/Makefile Thu Nov 24 21:51:10 2005 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.309 2005/11/24 10:16:54 rillig Exp $
+# $NetBSD: Makefile,v 1.310 2005/11/24 21:51:10 rillig Exp $
#
-DISTNAME= pkglint-4.46
+DISTNAME= pkglint-4.46.1
CATEGORIES= pkgtools
MASTER_SITES= # empty
DISTFILES= # empty
diff -r cc61d5ec3678 -r 3720dab5a79f pkgtools/pkglint/files/deprecated.map
--- a/pkgtools/pkglint/files/deprecated.map Thu Nov 24 20:33:38 2005 +0000
+++ b/pkgtools/pkglint/files/deprecated.map Thu Nov 24 21:51:10 2005 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: deprecated.map,v 1.13 2005/11/02 23:18:38 rillig Exp $
+# $NetBSD: deprecated.map,v 1.14 2005/11/24 21:51:10 rillig Exp $
#
# This file contains names of Makefile variables and a short explanation
@@ -23,3 +23,4 @@
FETCH_DEPENDS Use DEPENDS instead.
LIB_DEPENDS Use DEPENDS instead.
RUN_DEPENDS Use DEPENDS instead.
+ALLFILES Use CKSUMFILES instead.
diff -r cc61d5ec3678 -r 3720dab5a79f pkgtools/pkglint/files/pkglint.pl
--- a/pkgtools/pkglint/files/pkglint.pl Thu Nov 24 20:33:38 2005 +0000
+++ b/pkgtools/pkglint/files/pkglint.pl Thu Nov 24 21:51:10 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.384 2005/11/24 10:47:51 rillig Exp $
+# $NetBSD: pkglint.pl,v 1.385 2005/11/24 21:51:10 rillig Exp $
#
# This version contains lots of changes necessary for NetBSD packages
# done by:
@@ -206,11 +206,13 @@
}
}
-sub explain($$$) {
- my ($file, $lines, $msg) = @_;
+sub explain($$@) {
+ my ($file, $lines, @texts) = @_;
if ($explain_flag) {
- print STDOUT ("${indent} ${msg}\n");
+ foreach my $text (@texts) {
+ print STDOUT ("${indent} ${text}\n");
+ }
}
}
@@ -355,9 +357,9 @@
}
PkgLint::Logging::log_debug($self->[FILE], $self->[LINES], $text);
}
-sub explain($$) {
- my ($self, $text) = @_;
- PkgLint::Logging::explain($self->[FILE], $self->[LINES], $text);
+sub explain($@) {
+ my ($self, @texts) = @_;
+ PkgLint::Logging::explain($self->[FILE], $self->[LINES], @texts);
}
sub to_string($) {
@@ -756,6 +758,15 @@
)+ | ;;? | &&? | \|\|? | <<? | >>? | \#.*)"sx;
#
+# Commonly used explanations for diagnostics.
+#
+
+use constant expl_relative_dirs => (
+ "Directories in the form \"category/package\" make it easier to move",
+ "a package around in pkgsrc, for example from pkgsrc-wip to the main",
+ "pkgsrc repository.");
+
+#
# Global variables.
#
@@ -1063,6 +1074,10 @@
if (length($line->text) > $maxlength) {
$line->log_warning("Line too long (should be no more than $maxlength characters).");
+ $line->explain(
+ "Back in the old time, terminals with 80x25 characters were common.",
+ "And this is still the default size of many terminal emulators.",
+ "Moderately short lines also make reading easier.");
}
}
@@ -1098,7 +1113,7 @@
sub checkline_trailing_whitespace($) {
my ($line) = @_;
if ($line->text =~ /\s+$/) {
- $line->log_warning("Trailing white-space.");
+ $line->log_note("Trailing white-space.");
}
}
@@ -1131,7 +1146,7 @@
$last--;
}
if ($last != $max) {
- $lines->[$last]->log_warning("Trailing empty lines.");
+ $lines->[$last]->log_note("Trailing empty lines.");
}
}
@@ -1164,7 +1179,13 @@
checklines_trailing_empty_lines($descr);
if (@{$descr} > $maxlines) {
- log_warning($fname, NO_LINE_NUMBER, "File too long (should be no more than $maxlines lines).");
+ my $line = $descr->[$maxlines];
+
+ $line->log_warning("File too long (should be no more than $maxlines lines).");
+ $line->explain(
+ "A common terminal size is 80x25 characters. The DESCR file should",
+ "fit on one screen. It is also intended to give a _brief_ summary",
+ "about the package's contents.");
}
}
@@ -1188,6 +1209,7 @@
checkline_rcsid($lines->[0], "");
if (1 <= $#{$lines} && $lines->[1]->text ne "") {
$lines->[1]->log_warning("Empty line expected.");
+ $lines->[1]->explain("This is merely for aesthetical purposes.");
}
foreach my $line (@{$lines}[2..$#{$lines}]) {
@@ -1211,6 +1233,9 @@
}
} elsif (!$hack_php_patches) {
$line->log_warning("$file does not exist.");
+ $line->explain(
+ "All patches that are mentioned in a distinfo file should actually exist.",
+ "What's the use of a checksum if there is no file to check?");
}
} else {
$sums{$alg}->{$file} = $line;
@@ -1238,6 +1263,12 @@
my ($fname) = @_;
my ($message);
+ my @explanation = (
+ "A MESSAGE file should consist of a header line, having 75 \"=\"",
+ "characters, followed by a line containing only the RCS Id, then an",
+ "empty line, your text and finally the footer line, which is the",
+ "same as the header line.");
+
log_info($fname, NO_LINE_NUMBER, "[checkfile_MESSAGE]");
checkperms($fname);
@@ -1248,10 +1279,12 @@
if (@{$message} < 3) {
log_warning($fname, NO_LINE_NUMBER, "File too short.");
+ explain($fname, NO_LINE_NUMBER, @explanation);
return;
}
if ($message->[0]->text ne "=" x 75) {
$message->[0]->log_warning("Expected a line of exactly 75 \"=\" characters.");
+ explain($fname, NO_LINE_NUMBER, @explanation);
}
checkline_rcsid($message->[1], "");
foreach my $line (@{$message}) {
@@ -1261,6 +1294,7 @@
}
if ($message->[-1]->text ne "=" x 75) {
$message->[-1]->log_warning("Expected a line of exactly 75 \"=\" characters.");
+ explain($fname, NO_LINE_NUMBER, @explanation);
}
checklines_trailing_empty_lines($message);
}
@@ -1291,8 +1325,11 @@
if ($text =~ /^\@([a-z]+)\s+(.*)/) {
my ($cmd, $arg) = ($1, $2);
- if ($cmd eq "unexec" && $arg =~ /^rmdir/) {
- $line->log_warning("Use \"\@dirrm\" instead of \"\@unexec rmdir\".");
+ if ($cmd eq "unexec" && $arg =~ qr"^(rmdir|\$\{RMDIR\})(.*)") {
+ my ($rmdir, $rest) = ($1, $2);
+ if ($rest !~ qr"(?:true|\$\{TRUE\})") {
+ $line->log_warning("Use \"\@dirrm\" instead of \"\@unexec rmdir\".");
+ }
} elsif (($cmd eq "exec" || $cmd eq "unexec")) {
if ($arg =~ /(?:install-info|\$\{INSTALL_INFO\})/) {
@@ -1556,6 +1593,7 @@
if ($is_include_line) {
if ($includefile =~ qr"^\.\./[^./][^/]*/[^/]+") {
$line->log_warning("Relative directories should look like \"../../category/package\", not \"../package\".");
+ $line->explain(expl_relative_dirs);
}
if ($includefile =~ qr"(?:^|/)Makefile.common$"
|| ($includefile =~ qr"^(?:\.\./(?:\.\./[^/]+/)?[^/]+/)?([^/]+)$" && $1 ne "buildlink3.mk")) {
@@ -1770,6 +1808,9 @@
} elsif ($type eq "Dependency") {
if ($value eq $value_novar && $value !~ qr"^[-*+.0-9<=>\@A-Z_a-z\[\]]+$") {
$line->log_warning("\"${value}\" is not a valid dependency.");
+ $line->explain(
+ "Typical dependencies have the form \"package>=2.5\", \"package-[0-9]*\"",
+ "or \"package-3.141\".");
}
} elsif ($type eq "DependencyWithPath") {
@@ -1803,9 +1844,15 @@
} elsif ($value =~ qr":\.\./[^/]+$") {
$line->log_warning("Dependencies should have the form \"../../category/package\".");
+ $line->explain(expl_relative_dirs);
} else {
$line->log_warning("Unknown dependency format.");
+ $line->explain(
+ "Examples for valid dependencies are:",
+ " package-[0-9]*:../../category/package",
+ " package>=3.41:../../category/package",
+ " package-2.718:../../category/package");
}
} elsif ($type eq "DistSuffix") {
@@ -1890,6 +1937,10 @@
} elsif ($type eq "RelativePkgDir") {
if ($value !~ qr"^\.\./\.\./[^/]+/[^/]+$") {
$line->log_warning("\"${value}\" is not a valid relative package directory.");
+ $line->explain(
+ "A relative package directory always starts with \"../../\", followed",
+ "by a category, a slash and a the directory name of the package.",
+ "For example, \"../../misc/screen\" is a relative package directory.");
}
} elsif ($type eq "ShellWord") {
@@ -2663,14 +2714,12 @@
sub checkfile_package_Makefile($$$$) {
my ($fname, $whole, $main_lines, $lines) = @_;
- my ($distname, $category, $distfiles);
+ my ($distname, $distfiles);
log_info($fname, NO_LINE_NUMBER, "[checkfile_package_Makefile]");
checkperms($fname);
- $category = basename(dirname(Cwd::abs_path($current_dir)));
-
# TODO: "Use \${VARIABLE} instead of \$(VARIABLE)."
checklines_deprecated_variables($main_lines);
Home |
Main Index |
Thread Index |
Old Index