pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/pkgtools/pkglint/files - Installing documentation to s...
details: https://anonhg.NetBSD.org/pkgsrc/rev/cdb2dfb37d20
branches: trunk
changeset: 508375:cdb2dfb37d20
user: rillig <rillig%pkgsrc.org@localhost>
date: Sat Feb 18 16:12:13 2006 +0000
description:
- Installing documentation to share/doc/html is deprecated. By default, no
warnings are shown for this, as this would produce more than 20000 new
warnings for the current pkgsrc tree. You need to specify -Wplist-depr
(new) to see them. Of course, -Wall will work, too.
- Updated the documentation and cleaned it up.
diffstat:
pkgtools/pkglint/files/pkglint.0 | 166 +++++++++++++++++--------------------
pkgtools/pkglint/files/pkglint.1 | 32 +++---
pkgtools/pkglint/files/pkglint.pl | 8 +-
3 files changed, 97 insertions(+), 109 deletions(-)
diffs (truncated from 366 to 300 lines):
diff -r cbd3475ad5e4 -r cdb2dfb37d20 pkgtools/pkglint/files/pkglint.0
--- a/pkgtools/pkglint/files/pkglint.0 Sat Feb 18 16:09:59 2006 +0000
+++ b/pkgtools/pkglint/files/pkglint.0 Sat Feb 18 16:12:13 2006 +0000
@@ -1,7 +1,7 @@
PKGLINT(1) NetBSD General Commands Manual PKGLINT(1)
NNAAMMEE
- ppkkgglliinntt -- a verifier for pkgsrc directories
+ ppkkgglliinntt -- static analyzer for pkgsrc packages
SSYYNNOOPPSSIISS
ppkkgglliinntt [--ooppttiioonnss] [_d_i_r _._._.]
@@ -14,127 +14,117 @@
conformance tests. Packages following these rules are assumed to make
future changes to the pkgsrc infrastructure easier.
- OOppttiioonnss
+ OOppttiioonnss
+ --CC{{[[nnoo--]]cchheecckk,,......}} Enable or disable specific checks. For a list of
+ checks, see below.
- --CC{{[[nnoo--]]cchheecckk,,......}} Enable or disable specific checks. For a list
- of checks, see below.
+ --FF|----aauuttooffiixx Repair trivial things automatically.
- --FF|----aauuttooffiixx Repair trivial things automatically. Currently
- this only works for the synchronization of cat-
- egory _M_a_k_e_f_i_l_es.
+ --II Show the _M_a_k_e_f_i_l_e that is constructed by including
+ all the files that are slurped in via `.include'
+ directives. This flag is mainly for debugging.
- --II Show the _M_a_k_e_f_i_l_e that is constructed by
- including all the files that are slurped in via
- `.include' directives. This flag is mainly for
- debugging.
+ --RR|----rrccssiiddssttrriinngg Allow other RCS Id strings than NetBSD. Multiple
+ strings may be concatenated with `|'.
- --RR|----rrccssiiddssttrriinngg Allow other RCS Id strings than NetBSD. Multi-
- ple strings may be concatenated with `|'.
+ --VV|----vveerrssiioonn Print the current ppkkgglliinntt version number and exit.
- --VV|----vveerrssiioonn Print the current ppkkgglliinntt version number and
- exit.
+ --WW{{[[nnoo--]]wwaarrnn,,......}} Enable or disable specific warnings. For a list of
+ warnings, see below.
- --WW{{[[nnoo--]]wwaarrnn,,......}} Enable or disable specific warnings. For a
- list of warnings, see below.
+ --dd|----ddeebbuugg Enable warnings for parsing errors and other things
+ that haven't been completed yet. This option is sep-
+ arated from the `-W' options because the diagnostics
+ are too hard to understand without detailed knowledge
+ of pkglint's source code.
- --dd|----ddeebbuugg Enable warnings for parsing errors and other
- things that haven't been completed yet. This
- option is separated from the `-W' options
- because the diagnostics are too hard to under-
- stand without detailed knowledge of pkglint's
- source code.
+ --ee|----eexxppllaaiinn Print further explanations for diagnostics. Some-
+ times the reasons for diagnostics are not obvious and
+ need further explanation.
- --ee|----eexxppllaaiinn Print further explanations for diagnostics.
- Sometimes the reasons for diagnostics are not
- obvious and need further explanation.
+ --gg|----ggcccc--oouuttppuutt--ffoorrmmaatt
+ Use a format for the diagnostics that is understood
+ by most programs, especially editors, so they can
+ provide a point-and-goto interface.
+
+ --hh|----hheellpp Show the summary of command line options, then exit.
- --gg|----ggcccc--oouuttppuutt--ffoorrmmaatt
- Use a format for the diagnostics that is under-
- stood by most programs, especially editors, so
- they can provide a point-and-goto interface.
+ --ii|----iimmppoorrtt Check if a package is ready to be imported into
+ pkgsrc. This is especially useful for packages from
+ the pkgsrc-wip project.
- --hh|----hheellpp Show the summary of command line options, then
- exit.
+ --qq|----qquuiieett Don't print the errors and warnings summary before
+ terminating.
- --ii|----iimmppoorrtt Check if a package is ready to be imported into
- pkgsrc. This is especially useful for packages
- from the pkgsrc-wip project.
+ --rr Check subdirectories, too. The subdirectories are
+ those that are mentioned in a `SUBDIR+=' line.
- --qq|----qquuiieett Don't print the errors and warnings summary
- before terminating.
+ --ss|----ssoouurrccee For all diagnostics having file and line number
+ information, show the source code along with the
+ diagnostics.
- --rr Check subdirectories, too. The subdirectories
- are those that are mentioned in a `SUBDIR+='
- line.
+ --vv|----vveerrbboossee Be verbose. Show the progress report for items that
+ are being checked. If given more than once, debug-
+ ging messages are also shown.
- --ss|----ssoouurrccee For all diagnostics having file and line number
- information, show the source code along with
- the diagnostics.
-
- --vv|----vveerrbboossee Be verbose. Show the progress report for items
- that are being checked. If given more than
- once, debugging messages are also shown.
+ CChheecckkss
+ aallll Enable all checks.
- CChheecckkss
+ nnoonnee Disable all checks.
- aallll Enable all checks.
+ [[nnoo--]]AALLTTEERRNNAATTIIVVEESS Check the alternatives file.
- nnoonnee Disable all checks.
+ [[nnoo--]]IINNSSTTAALLLL Check the INSTALL and DEINSTALL scripts.
- [[nnoo--]]AALLTTEERRNNAATTIIVVEESS Check the alternatives file.
+ [[nnoo--]]MMaakkeeffiillee Check the package Makefile, including all included
+ files.
- [[nnoo--]]IINNSSTTAALLLL Check the INSTALL and DEINSTALL scripts.
+ [[nnoo--]]MMEESSSSAAGGEE Check MESSAGE files.
- [[nnoo--]]MMaakkeeffiillee Check the package Makefile, including all
- included files.
+ [[nnoo--]]PPLLIISSTT Check PLIST files.
- [[nnoo--]]MMEESSSSAAGGEE Check MESSAGE files.
-
- [[nnoo--]]PPLLIISSTT Check PLIST files.
+ [[nnoo--]]bbll33 Check buildlink3 Makefiles.
- [[nnoo--]]bbll33 Check buildlink3 Makefiles.
+ [[nnoo--]]ddiissttiinnffoo Check the distinfo file.
- [[nnoo--]]ddiissttiinnffoo Check the distinfo file.
+ [[nnoo--]]eexxttrraa Check remaining files in the package directory.
- [[nnoo--]]eexxttrraa Check remaining files in the package directory.
+ [[nnoo--]]mmkk Check Makefile fragments besides buildlink3.
- [[nnoo--]]mmkk Check Makefile fragments besides buildlink3.
+ [[nnoo--]]ppaattcchheess Check the pkgsrc specific patch files.
- [[nnoo--]]ppaattcchheess Check the pkgsrc specific patch files.
+ WWaarrnniinnggss
+ aallll Enable all warnings.
- WWaarrnniinnggss
+ nnoonnee Disable all warnings.
- aallll Enable all warnings.
+ [[nnoo--]]aabbssnnaammee Warn if a file contains an absolute pathname.
- nnoonnee Disable all warnings.
-
- [[nnoo--]]aabbssnnaammee Warn if a file contains an absolute pathname.
+ [[nnoo--]]ddiirreeccttccmmdd Warn if a system command name is used instead of a
+ variable (e.g. sed instead of ${SED}).
- [[nnoo--]]ddiirreeccttccmmdd Warn if a system command name is used instead
- of a variable (e.g. sed instead of ${SED}).
+ [[nnoo--]]eexxttrraa Emit some additional warnings that are not enabled by
+ default, for whatever reason.
- [[nnoo--]]eexxttrraa Emit some additional warnings that are not
- enabled by default, for whatever reason.
+ [[nnoo--]]oorrddeerr Warn if Makefile variables are not in the preferred
+ order.
- [[nnoo--]]oorrddeerr Warn if Makefile variables are not in the pre-
- ferred order.
+ [[nnoo--]]pplliisstt--ddeepprr Warn if deprecated pathnames are used in _P_L_I_S_T files.
+ This warning is disabled by default.
- [[nnoo--]]pplliisstt--ssoorrtt Warn if items of a PLIST file are not sorted
- alphabetically. This warning is disabled by
- default.
+ [[nnoo--]]pplliisstt--ssoorrtt Warn if items of a PLIST file are not sorted alpha-
+ betically. This warning is disabled by default.
- [[nnoo--]]qquuoottiinngg Warn for possibly invalid quoting of make vari-
- ables in shell programs and shell variables
- themselves.
+ [[nnoo--]]qquuoottiinngg Warn for possibly invalid quoting of make variables
+ in shell programs and shell variables themselves.
- [[nnoo--]]ssppaaccee Emit notes for inconsistent use of white-space.
+ [[nnoo--]]ssppaaccee Emit notes for inconsistent use of white-space.
- [[nnoo--]]ttyyppeess Warn for some _M_a_k_e_f_i_l_e variables if their
- assigned values do not match their type.
+ [[nnoo--]]ttyyppeess Warn for some _M_a_k_e_f_i_l_e variables if their assigned
+ values do not match their type.
- [[nnoo--]]vvaarroorrddeerr Warn if the variables in a package _M_a_k_e_f_i_l_es
- are not ordered in the way it is described the
- pkgsrc guide.
+ [[nnoo--]]vvaarroorrddeerr Warn if the variables in a package _M_a_k_e_f_i_l_es are not
+ ordered in the way it is described the pkgsrc guide.
OOtthheerr aarrgguummeennttss
@@ -169,16 +159,12 @@
(--vv). Their main use is to aid debugging.
AAUUTTHHOORRSS
- Jun-ichiro Itoh <itojun%itojun.org@localhost>
- Yoshishige Arai <ryo2%on.rim.or.jp@localhost>
Roland Illig <rillig%NetBSD.org@localhost>
- Many people have contributed patches and comments/suggestions.
-
BBUUGGSS
Many more checks could be added.
If you don't understand the messages, feel free to ask on the
<tech-pkg%NetBSD.org@localhost> mailing list.
-pkgsrc January 20, 2006 pkgsrc
+NetBSD 3.0 February 18, 2006 NetBSD 3.0
diff -r cbd3475ad5e4 -r cdb2dfb37d20 pkgtools/pkglint/files/pkglint.1
--- a/pkgtools/pkglint/files/pkglint.1 Sat Feb 18 16:09:59 2006 +0000
+++ b/pkgtools/pkglint/files/pkglint.1 Sat Feb 18 16:12:13 2006 +0000
@@ -1,17 +1,17 @@
-.\" $NetBSD: pkglint.1,v 1.36 2006/01/20 13:33:37 rillig Exp $
+.\" $NetBSD: pkglint.1,v 1.37 2006/02/18 16:12:13 rillig Exp $
.\" From FreeBSD: portlint.1,v 1.8 1997/11/25 14:53:14 itojun Exp
.\"
.\" Copyright (c) 1997 by Jun-ichiro Itoh <itojun%itojun.org@localhost>.
.\" All Rights Reserved. Absolutely no warranty.
.\"
.\" Roland Illig <roland.illig%gmx.de@localhost>, 2004, 2005.
-.\" Roland Illig <rillig%NetBSD.org@localhost>, 2005.
+.\" Roland Illig <rillig%NetBSD.org@localhost>, 2005, 2006.
.\"
-.Dd January 20, 2006
+.Dd February 18, 2006
.Dt PKGLINT 1
.Sh NAME
.Nm pkglint
-.Nd a verifier for pkgsrc directories
+.Nd static analyzer for pkgsrc packages
.Sh SYNOPSIS
.Nm pkglint
.Op Fl options
@@ -30,16 +30,13 @@
pkgsrc infrastructure easier.
.Pp
.\" =======================================================================
-.Sy Options
-.Bl -tag -width 18n -offset indent
+.Ss Options
+.Bl -tag -width 18n
.It Fl C{[no-]check,...}
Enable or disable specific checks.
For a list of checks, see below.
.It Fl F Ns | Ns Fl -autofix
Repair trivial things automatically.
-Currently this only works for the synchronization of category
-.Pa Makefile Ns
-s.
.It Fl I
Show the
.Pa Makefile
@@ -95,8 +92,8 @@
.El
.Pp
.\" =======================================================================
-.Sy Checks
-.Bl -tag -width 18n -offset indent
+.Ss Checks
+.Bl -tag -width 18n
.It Cm all
Enable all checks.
.It Cm none
@@ -124,8 +121,8 @@
.El
.Pp
.\" =======================================================================
-.Sy Warnings
-.Bl -tag -width 18n -offset indent
+.Ss Warnings
+.Bl -tag -width 18n
.It Cm all
Enable all warnings.
.It Cm none
@@ -140,6 +137,11 @@
for whatever reason.
Home |
Main Index |
Thread Index |
Old Index