| @@ -1,23 +1,23 @@ | | | @@ -1,23 +1,23 @@ |
1 | .\" $NetBSD: pkglint.1,v 1.43 2006/10/22 05:26:41 rillig Exp $ | | 1 | .\" $NetBSD: pkglint.1,v 1.44 2012/07/09 17:36:59 wiz Exp $ |
2 | .\" From FreeBSD: portlint.1,v 1.8 1997/11/25 14:53:14 itojun Exp | | 2 | .\" From FreeBSD: portlint.1,v 1.8 1997/11/25 14:53:14 itojun Exp |
3 | .\" | | 3 | .\" |
4 | .\" Copyright (c) 1997 by Jun-ichiro Itoh <itojun@itojun.org>. | | 4 | .\" Copyright (c) 1997 by Jun-ichiro Itoh <itojun@itojun.org>. |
5 | .\" All Rights Reserved. Absolutely no warranty. | | 5 | .\" All Rights Reserved. Absolutely no warranty. |
6 | .\" | | 6 | .\" |
7 | .\" Roland Illig <roland.illig@gmx.de>, 2004, 2005. | | 7 | .\" Roland Illig <roland.illig@gmx.de>, 2004, 2005. |
8 | .\" Roland Illig <rillig@NetBSD.org>, 2005, 2006. | | 8 | w.\" Thomas Klausner <rillig@NetBSD.org>, 2012. |
9 | .\" | | 9 | .\" |
10 | .Dd July 27, 2006 | | 10 | .Dd July 9, 2012 |
11 | .Dt PKGLINT 1 | | 11 | .Dt PKGLINT 1 |
12 | .Sh NAME | | 12 | .Sh NAME |
13 | .Nm pkglint | | 13 | .Nm pkglint |
14 | .Nd static analyzer for pkgsrc packages | | 14 | .Nd static analyzer for pkgsrc packages |
15 | .Sh SYNOPSIS | | 15 | .Sh SYNOPSIS |
16 | .Nm pkglint | | 16 | .Nm pkglint |
17 | .Op Fl options | | 17 | .Op Fl options |
18 | .Op Ar dir ... | | 18 | .Op Ar dir ... |
19 | .Sh DESCRIPTION | | 19 | .Sh DESCRIPTION |
20 | .Nm | | 20 | .Nm |
21 | attempts to detect features of the named pkgsrc packages that are likely | | 21 | attempts to detect features of the named pkgsrc packages that are likely |
22 | to be bugs, or that are simply deprecated. | | 22 | to be bugs, or that are simply deprecated. |
23 | .Pp | | 23 | .Pp |
| @@ -149,26 +149,42 @@ Enable all warnings. | | | @@ -149,26 +149,42 @@ Enable all warnings. |
149 | Disable all warnings. | | 149 | Disable all warnings. |
150 | .It Cm [no-]absname | | 150 | .It Cm [no-]absname |
151 | Warn if a file contains an absolute pathname. | | 151 | Warn if a file contains an absolute pathname. |
152 | .It Cm [no-]directcmd | | 152 | .It Cm [no-]directcmd |
153 | Warn if a system command name is used instead of a variable (e.g. sed | | 153 | Warn if a system command name is used instead of a variable (e.g. sed |
154 | instead of ${SED}). | | 154 | instead of ${SED}). |
155 | .It Cm [no-]extra | | 155 | .It Cm [no-]extra |
156 | Emit some additional warnings that are not enabled by default, | | 156 | Emit some additional warnings that are not enabled by default, |
157 | for whatever reason. | | 157 | for whatever reason. |
158 | .It Cm [no-]order | | 158 | .It Cm [no-]order |
159 | Warn if Makefile variables are not in the preferred order. | | 159 | Warn if Makefile variables are not in the preferred order. |
160 | .It Cm [no-]perm | | 160 | .It Cm [no-]perm |
161 | Warn if a variable is used or defined outside its specified scope. | | 161 | Warn if a variable is used or defined outside its specified scope. |
| | | 162 | The available permissions are: |
| | | 163 | .Bl -tag -width 3n -compact |
| | | 164 | .It a |
| | | 165 | append something using += |
| | | 166 | .It d |
| | | 167 | set a default value using ?= |
| | | 168 | .It s |
| | | 169 | set a variable using :=, =, != |
| | | 170 | .It p |
| | | 171 | use a variable during preprocessing |
| | | 172 | .It u |
| | | 173 | use a variable at runtime |
| | | 174 | .El |
| | | 175 | A |
| | | 176 | .Sq \&? |
| | | 177 | means that it is not yet clear which permissions are allowed and which aren't. |
162 | .It Cm [no-]plist-depr | | 178 | .It Cm [no-]plist-depr |
163 | Warn if deprecated pathnames are used in | | 179 | Warn if deprecated pathnames are used in |
164 | .Pa PLIST | | 180 | .Pa PLIST |
165 | files. | | 181 | files. |
166 | This warning is disabled by default. | | 182 | This warning is disabled by default. |
167 | .It Cm [no-]plist-sort | | 183 | .It Cm [no-]plist-sort |
168 | Warn if items of a PLIST file are not sorted alphabetically. | | 184 | Warn if items of a PLIST file are not sorted alphabetically. |
169 | This warning is disabled by default. | | 185 | This warning is disabled by default. |
170 | .It Cm [no-]quoting | | 186 | .It Cm [no-]quoting |
171 | Warn for possibly invalid quoting of make variables in shell programs | | 187 | Warn for possibly invalid quoting of make variables in shell programs |
172 | and shell variables themselves. | | 188 | and shell variables themselves. |
173 | .It Cm [no-]space | | 189 | .It Cm [no-]space |
174 | Emit notes for inconsistent use of white-space. | | 190 | Emit notes for inconsistent use of white-space. |