CVS log for pkgsrc/pkgtools/pkglint/TODO

Up to [NetBSD + pkgsrc-wip] / pkgsrc / pkgtools / pkglint

Request diff between arbitrary revisions - Display revisions graphically

Keyword substitution: kv
Default branch: MAIN

Updated pkglint to 4.93.

Changes since 4.92:
- Changes for the changing pkgsrc infrastructure
- Added basic support for LICENSE expressions

+ complain if LICENSE definition is missing

note that pkglint doesn't understand dual licenses

take case-insensitive filesystems into account.

more to do.

It already tries.

Main tree must not depend on wip, so pkglint should try to warn about
it.

Add note about LOCALBASE

Add a suggestion from Aleksej Saushev.

There's more to do ...

Add TODO item from PR pkg/38178.

Added a suggestion from Tobias Nygren.

Something more to do.

Greg wants me to check for unused license files.

Cleaned up the TODO list from things I don't find worth implementing.

Fix a couple misspellings, and add a couple items:
* Check for parallel files/dirs whose names differ only in case
    (suggested by heinz)
* Check for German text in pkgtools/pkglint/TODO.

Another wish item: configure patches should not contain the pkgsrc
magic.

Some of the TODO entries have been done.

* Warn if LICENSE/RESTRICTED/NO_*_ON_* are misordered.

From the discussion in #pkgsrc of build problems of wip/gxmms2:
Packages using lang/python/extension.mk must follow the naming scheme
or otherwise they can't be depended on.

${MARCH_ARCH}-${LOWER_OPSYS}elf and related constructs should be fixed.

TODO:
* Check all the shell commands to see if they are mentioned in USE_TOOLS.

* Invent an annotation scheme for files that intentionally define
  variables for use in other files.

Updated pkglint to 4.66.

This change includes all the things I thought of during the freeze of
2006Q2.

Some variables have disappeared from pkgsrc without notice. Marked them
deprecated to help the package authors at least a bit.

Renamed some ACL abbreviations in makevars.map and adjusted the variable
definitions.

Added the command line options -Dtrace, -Dunchecked and -Dunused.

Some variables may contain unexpected white-space and therefore should
not be used in .for loops.

The -Dmisc option replaces the --verbose option (and the log_info
subroutine), which does not exist any longer. This eliminates all
instances of "OK:" from the output, which I didn't like from the
beginning. The -Dmisc option also takes over many warnings that have
been issued by --debug before.

Improved the check for absolute pathnames. Especially, everything that
follows ${DESTDIR} or $(DESTDIR) in a Makefile is considered an absolute
pathname. This reveals many wrong uses of DESTDIR (as defined by the GNU
coding standards), for example $(DESTDIR)/$(prefix), which should be
$(DESTDIR)$(prefix) instead.

Almost every use of a make(1) variable is checked for spelling mistakes.
Before, only the definitions of variables have been checked.

Restricted the use of variables to specific files, which are defined in
makevars.map. This catches especially buildlink3.mk files with
unexpected side effects.

In shell commands, neither "echo" nor "echo -n" or "${ECHO} -n" should
be used. Since the INSTALL_*_DIR commands can only handle one directory
at a time, suggest to use INSTALLATION_DIRS instead.

Greatly improved the checks for dependency specifications, especially to
find foo-*, which should rather be foo-[0-9]*.

Fixed the incorrect handling of LICENSE_FILE (now using $line->text
instead of $line).

Improved the wording of the "plural names" warnings, so that for known
variables it is "The += operator should only be used with lists." now.

In buildlink3.mk files the uppercase and lowercase names of the package
should correspond with the package name. This catches many
copy-and-paste mistakes. Fixed many null pointer exceptions as well. In
addition, every buildlink3.mk file needs a definition of
BUILDLINK_API_DEPENDS.

In patch files, absolute pathnames and unportable macro names are
checked not only in added lines, but also in the context lines.

In the pkgsrc root directory and the category directories, the Makefiles
are checked like every other Makefile, too.

Fixed the place where the global variables for the package context are
defined and later undefined.

Variables that are mentioned in EVAL_PREFIX may be used in the current
file and are not flagged as "used but not defined".

When parsing shell words in Makefiles, recognize $<, $@, $^ and $/.
(The latter is used extensively by openoffice to represent a directory
separator.)

Fixed some minor bugs:
* $makevar had been defined unintentionally by using the -> operator.

Some things from the TODO list have been done.

Add a wish for PYTHON_VERSIONS_INCOMPATIBLE.

Updated the TODO list.

Updated pkglint to 4.62.

Changes since 4.61:
- Bug fixes.

* In the vartypes.map, distinguish FOO and FOO.*.

Updated pkglint to 4.60.

Changes since 4.59:
- For many variables the :Q operator is not needed (by definition), for
  example some pathnames, user names, group names.
- Improved the diagnostics for planned package updates.
- Various catch-ups to recent changes in the infrastructure, among them
  BUILDLINK_ABI_DEPENDS and gettext.mk.
- When the PLIST contains a libtool archive, the *.a and *.so files don't
  have to be mentioned explicitly.

Possible warnings if the PLIST contains libtool archives, but the
package doesn't say it uses libtool. Warn for redundant libraries,
when the libtool archive is also included in the PLIST.

Debian's lintian has many ideas for things that pkglint could also check.
Maybe we can use some of them.

* Many of the checking routines need some context to provide better
  warnings. For example, checkline_foo() may need to know what has
  happened in the file before that line.

Wish for warning about BUILD_USES_MSGFMT being used without
devel/gettext-lib/buildlink3.mk being included. This is often,
but not always incorrect.

Added an RCS Id and an introductory comment.

Ask for warnings so that e.g. CONFIGURE_DIRS has overrides for
config.guess and config.sub as well.

Cleaned up the TODO list.

* record with each substring its source location to be able to make
  even more precise diagnostics

Index: has sometimes different precedence in patch, avoid problems.

* check quoting in CFLAGS+= -DPREFIX=\"${PREFIX:Q}\"

Cleaned up the TODO list.

The option names are now checked if they are in
mk/defaults/options.description.

I've sent joerg a patch which would fix his TODO item.

* IMAKE_MANNEWSUFFIX should be deprecated in PLISTs, says Joerg.

* check that all values used for the PKG_OPTIONS are documented in
  mk/defaults/options.description. Requested by Antoine Reilles via
  private mail.

- Reintroduced the check for absolute pathnames in shell commands. This
  check had been removed some time ago due to the huge number of false
  positives. Now that pkglint can parse shell commands quite well, it
  has been reintroduced, as absolute pathnames often indicate unportable
  features of a package. To implement this check (and a few others)
  accurately, the whole code for checking shell commands has been
  rewritten as a finite state machine.

Implemented the --explain option and the checks for CPP macros in patch
files. New TODO items:

* extract the DISTFILES if they exist and check all files in them for:
  - security holes,
  - coding style violations,
  - possible unportable constructs

* warn about unportable CPP macros in patches.

* mention the SUBST framework whenever ${SED} is used.

* warn about the use of ${WRKDIR:=...}, as this construct should only
  be used with lists.

The readmakefile() subroutine only returns the lines of the main Makefile
in the $all_lines parameter, but the whole text of the included files in
the $whole parameter.

This change avoids duplicate diagnostics for *.mk and Makefile* in the
package directory. A side effect is that package authors only get the
diagnostics they can probably fix, as diagnostics from included files are
not given.

* avoid duplicate warnings.

* detect spelling errors in variable names

* Find a reliable, secure way to delete all CVS directories inside
  ${WRKSRC}. When that is finished, add a warning that using ${XARGS}
  is insecure.

diff:
- check for magic numbers like 0755, 755, 644
+ check for direct use of user names and group names

+ check for magic numbers like 0755, 755, 644

* check Makefile directives
* check _every_ line of the Makefiles
* warn about the use of ${SED} in {pre,do,post}-install

+ include "../../mk/bsd.prefs.mk" before any .if.

include ../../mk/bsd.prefs.mk before using "+=".

The "../.." and PERL5_PACKLIST checks are implemented.

Updated pkglint to 4.28.1.

Declared some more variables as List types. Added a check that
PERL5_PACKLIST matches the PKGNAME.

"-Wl,-rpath" should not be used directly. ${COMPILER_RPATH_FLAG} is better.

Cleaned up the TODO list.

Updated pkglint to 4.22.

A distfile that only has an SHA1 checksum, but not an RMD160 one, is
considered an error. While at it, made the distinfo file check a little
stricter.

Checking for C/C++ comments is not necessary for Makefiles. No-one uses
them. All pathnames are already interpreted as being relative to the
package's directory. Added a reminder that ONLY_FOR_PLATFORM should be
changed to NOT_FOR_PLATFORM where appropriate.

TODO: make all pathnames relative to the current directory.

Check for non-normalized dependency lines like package:../package instead
of package:../../category/package.

Removed unused subroutine abspathname. Added the things it did to the TODO
list.

Add: * fatal error if RMD160 missing

Removed the check for absolute filenames, as it has produced too many
false positive warnings. Added a reminder to TODO that a similar check
be added to pkglint. Welcome to 4.15.

TODO: Check for C/C++ style comments in Makefiles.

Added --explain option.

Added TODO list for pkglint.