summaryrefslogtreecommitdiff
path: root/pkgtools/pkglint/files/pkglint.0
blob: a421b7c9ffa23dc0f6de7f3b8054a2506f589e1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
PKGLINT(1)                  General Commands Manual                 PKGLINT(1)

NNAAMMEE
     ppkkgglliinntt - static analyzer for pkgsrc packages

SSYYNNOOPPSSIISS
     ppkkgglliinntt [--ooppttiioonnss] [_d_i_r _._._.]

DDEESSCCRRIIPPTTIIOONN
     ppkkgglliinntt attempts to detect features of the named pkgsrc packages that are
     likely to be bugs, or that are simply deprecated.


   OOppttiioonnss
     --CC{{[[nnoo--]]cchheecckk,,......}}  Enable or disable specific checks.  For a list of
                         checks, see below.

     --dd|----ddeebbuugg          Enable or disable verbose log for debugging pkglint.

     --ee|----eexxppllaaiinn        Print verbose explanations for diagnostics.

     --FF|----aauuttooffiixx        Repair some of the warnings automatically.

     --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.

     --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|----iimmppoorrtt         Check if a package is ready to be imported into
                         pkgsrc.  This is especially useful for packages from
                         the pkgsrc-wip project.

     --oo|----oonnllyy _s_u_b_s_t_r_i_n_g
                         Only handle those diagnostics that have _s_u_b_s_t_r_i_n_g in
                         their text.  This is useful in combination with
                         ----aauuttooffiixx and ----rreeccuurrssiivvee,, to fix only a single kind
                         of warning in a large number of files.

     --qq|----qquuiieett          Don't print the errors and warnings summary before
                         terminating.

     --rr|----rreeccuurrssiivvee      Check subdirectories, too.  The subdirectories are
                         those that are mentioned in a `SUBDIR+=' line.

     --ss|----ssoouurrccee         For all diagnostics having file and line number
                         information, show the source code along with the
                         diagnostics.  This is especially useful together with
                         the --ff|----sshhooww--aauuttooffiixx option.

     --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.

   CChheecckkss
     aallll                 Enable all checks.

     nnoonnee                Disable all checks.

     [[nnoo--]]eexxttrraa          Check remaining files in the package directory.

     [[nnoo--]]gglloobbaall         Check inter-package consistency for distfile hashes
                         and used licenses.

   WWaarrnniinnggss
     aallll                 Enable all warnings.

     nnoonnee                Disable all warnings.

     [[nnoo--]]eexxttrraa          Emit some additional warnings that are not enabled by
                         default.

     [[nnoo--]]ppeerrmm           Warn if a variable is used or modified outside its
                         specified scope.

     [[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 whitespace.

     [[nnoo--]]ssttyyllee          Warn for stylistic issues that don't affect the build
                         process.

   OOtthheerr aarrgguummeennttss
           _d_i_r _._._.             The pkgsrc directories to be checked.  If
                               omitted, the current directory is checked.

FFIILLEESS
     _p_k_g_s_r_c_/_m_k_/_*  Files from the pkgsrc infrastructure.

EEXXAAMMPPLLEESS
     ppkkgglliinntt ..   Checks the package in the current directory.

     ppkkgglliinntt --WWaallll //uussrr//ppkkggssrrcc//ddeevveell
                 Checks the category Makefile and reports any warnings it can
                 find.

DDIIAAGGNNOOSSTTIICCSS
     Diagnostics are written to the standard output.

     ERROR: ...    Errors should be fixed before a package is committed to
                   pkgsrc.

     WARN: ...     Warnings generally should be fixed, but they are not as
                   critical as errors.

AAUUTTHHOORRSS
     Roland Illig <_r_i_l_l_i_g_@_N_e_t_B_S_D_._o_r_g>

BBUUGGSS
     If you don't understand the messages, feel free to ask the author or on
     the <pkgsrc-users@pkgsrc.org> mailing list.

NetBSD 8.0                     January 14, 2018                     NetBSD 8.0