summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2005-12-01 04:05:36 +0000
committerrillig <rillig@pkgsrc.org>2005-12-01 04:05:36 +0000
commitb8dbe27051b401eb4e8a575f03f249d418e23cf0 (patch)
tree28f5dfb10d5aeb6e9b74b4a8a4a696ee6f8dc163
parent5b96d2b5f4e35033c11d9d54555dbe92e24738c1 (diff)
downloadpkgsrc-b8dbe27051b401eb4e8a575f03f249d418e23cf0.tar.gz
Replaced the DESCR from the year 2001 with a current one, since pkglint has
changed since that time.
-rw-r--r--pkgtools/pkglint/DESCR15
1 files changed, 6 insertions, 9 deletions
diff --git a/pkgtools/pkglint/DESCR b/pkgtools/pkglint/DESCR
index aa677c3672e..bff78e0924e 100644
--- a/pkgtools/pkglint/DESCR
+++ b/pkgtools/pkglint/DESCR
@@ -1,10 +1,7 @@
-pkglint tries to verify the content of a package directory.
-The purpose of pkglint can be separated into two parts:
- (1) to let the submitters easily polish her/his own package
- directory, and
- (2) to decrease the labor of the committers.
+pkglint is for pkgsrc packages what lint(1) is for C files. It checks
+for various things that the used languages cannot detect, for example
+application-specific restrictions on certain variables.
-pkglint uses very simple regular-expression matching for verifying
-files that make up a package directory. Note that it does NOT implement
-complete parser for those files. Because of this the user may see some
-extra warnings, especially when checking complex Makefiles.
+Before importing a new package or making changes to an existing package,
+pkglint should be run in the package's directory to check for common
+errors.