pkgsrc/pkgtools/pkglint
2006-02-28 23:25:23 +00:00
..
files Added more documentation on the format of the diagnostics. 2006-02-28 23:25:23 +00:00
DESCR Replaced the DESCR from the year 2001 with a current one, since pkglint has 2005-12-01 04:05:36 +00:00
Makefile Fixed pkglint warnings. 2006-02-25 15:56:24 +00:00
PLIST 4.15.1: Fix PLIST (hi Roland!). 2005-05-18 21:06:58 +00:00
README The section on the pkglint type system has been moved to the pkglint book. 2006-02-28 15:21:09 +00:00
TODO * Many of the checking routines need some context to provide better 2006-02-04 03:39:40 +00:00

$NetBSD: README,v 1.3 2006/02/28 15:21:09 rillig Exp $

== Current problems ==

The current pkglint architecture will not scale much further. What is
needed next are parsers for nested, non-context-free languages (make(1),
sh(1), sed(1)). The parsers should be able to recognize partial
structures, as well as structures containing foreign parts. This is
because most of pkgsrc is heavily based on preprocessors:

- The .if and .for directives in Makefiles are preprocessed by make(1)
  before building dependencies and shell commands out of the remaining
  text.

- make(1) assembles shell commands from literal text and variables like
  ${PKGNAME}.

- Shell commands often use dynamic evaluation of variables.

All this makes enhancing pkglint non-trivial. If you know of any
academic papers that might be of help in this case, please tell me.

Additionally, the Perl programming language is not well suited to this
kind of tool. It does not provide:

- Sufficient static checking (especially for names of methods)
- A type system (you can apply almost any operator to any kind of data)
- Object orientation (needed for the future advanced parsers)
- Narrow scope for constants (it's just ugly)
- Enumeration data types
- Structured data types

The pkglint source code is much too big for a single file.