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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
package main
import (
"fmt"
"io"
"os"
"path/filepath"
"runtime/pprof"
)
const confMake = "@BMAKE@"
const confVersion = "@VERSION@"
func main() {
G.logOut, G.logErr, G.debugOut = os.Stdout, os.Stderr, os.Stdout
os.Exit(new(Pkglint).Main(os.Args...))
}
type Pkglint struct{}
func (pkglint *Pkglint) Main(args ...string) (exitcode int) {
defer func() {
if r := recover(); r != nil {
if _, ok := r.(pkglintFatal); ok {
exitcode = 1
} else {
panic(r)
}
}
}()
if exitcode := pkglint.ParseCommandLine(args); exitcode != nil {
return *exitcode
}
if G.opts.PrintVersion {
fmt.Fprintf(G.logOut, "%s\n", confVersion)
return 0
}
if G.opts.Profiling {
f, err := os.Create("pkglint.pprof")
if err != nil {
dummyLine.Fatalf("Cannot create profiling file: %s", err)
}
pprof.StartCPUProfile(f)
defer pprof.StopCPUProfile()
G.rematch = NewHistogram()
G.renomatch = NewHistogram()
G.retime = NewHistogram()
G.loghisto = NewHistogram()
}
for _, arg := range G.opts.args {
G.Todo = append(G.Todo, filepath.ToSlash(arg))
}
if len(G.Todo) == 0 {
G.Todo = []string{"."}
}
G.globalData.Initialize()
for len(G.Todo) != 0 {
item := G.Todo[0]
G.Todo = G.Todo[1:]
CheckDirent(item)
}
checkToplevelUnusedLicenses()
pkglint.PrintSummary()
if G.opts.Profiling {
G.loghisto.PrintStats("loghisto", G.logOut, 0)
G.rematch.PrintStats("rematch", G.logOut, 10)
G.renomatch.PrintStats("renomatch", G.logOut, 10)
G.retime.PrintStats("retime", G.logOut, 10)
}
if G.errors != 0 {
return 1
}
return 0
}
func (pkglint *Pkglint) ParseCommandLine(args []string) *int {
gopts := &G.opts
opts := NewOptions()
check := opts.AddFlagGroup('C', "check", "check,...", "enable or disable specific checks")
opts.AddFlagVar('d', "debug", &gopts.Debug, false, "log verbose call traces for debugging")
opts.AddFlagVar('e', "explain", &gopts.Explain, false, "explain the diagnostics or give further help")
opts.AddFlagVar('f', "show-autofix", &gopts.PrintAutofix, false, "show what pkglint can fix automatically")
opts.AddFlagVar('F', "autofix", &gopts.Autofix, false, "try to automatically fix some errors (experimental)")
opts.AddFlagVar('g', "gcc-output-format", &gopts.GccOutput, false, "mimic the gcc output format")
opts.AddFlagVar('h', "help", &gopts.PrintHelp, false, "print a detailed usage message")
opts.AddFlagVar('I', "dumpmakefile", &gopts.DumpMakefile, false, "dump the Makefile after parsing")
opts.AddFlagVar('i', "import", &gopts.Import, false, "prepare the import of a wip package")
opts.AddFlagVar('m', "log-verbose", &gopts.LogVerbose, false, "allow the same log message more than once")
opts.AddFlagVar('p', "profiling", &gopts.Profiling, false, "profile the executing program")
opts.AddFlagVar('q', "quiet", &gopts.Quiet, false, "don't print a summary line when finishing")
opts.AddFlagVar('r', "recursive", &gopts.Recursive, false, "check subdirectories, too")
opts.AddFlagVar('s', "source", &gopts.PrintSource, false, "show the source lines together with diagnostics")
opts.AddFlagVar('V', "version", &gopts.PrintVersion, false, "print the version number of pkglint")
warn := opts.AddFlagGroup('W', "warning", "warning,...", "enable or disable groups of warnings")
check.AddFlagVar("ALTERNATIVES", &gopts.CheckAlternatives, true, "check ALTERNATIVES files")
check.AddFlagVar("bl3", &gopts.CheckBuildlink3, true, "check buildlink3.mk files")
check.AddFlagVar("DESCR", &gopts.CheckDescr, true, "check DESCR file")
check.AddFlagVar("distinfo", &gopts.CheckDistinfo, true, "check distinfo file")
check.AddFlagVar("extra", &gopts.CheckExtra, false, "check various additional files")
check.AddFlagVar("global", &gopts.CheckGlobal, false, "inter-package checks")
check.AddFlagVar("INSTALL", &gopts.CheckInstall, true, "check INSTALL and DEINSTALL scripts")
check.AddFlagVar("Makefile", &gopts.CheckMakefile, true, "check Makefiles")
check.AddFlagVar("MESSAGE", &gopts.CheckMessage, true, "check MESSAGE file")
check.AddFlagVar("mk", &gopts.CheckMk, true, "check other .mk files")
check.AddFlagVar("patches", &gopts.CheckPatches, true, "check patches")
check.AddFlagVar("PLIST", &gopts.CheckPlist, true, "check PLIST files")
warn.AddFlagVar("absname", &gopts.WarnAbsname, true, "warn about use of absolute file names")
warn.AddFlagVar("directcmd", &gopts.WarnDirectcmd, true, "warn about use of direct command names instead of Make variables")
warn.AddFlagVar("extra", &gopts.WarnExtra, false, "enable some extra warnings")
warn.AddFlagVar("order", &gopts.WarnOrder, false, "warn if Makefile entries are unordered")
warn.AddFlagVar("perm", &gopts.WarnPerm, false, "warn about unforeseen variable definition and use")
warn.AddFlagVar("plist-depr", &gopts.WarnPlistDepr, false, "warn about deprecated paths in PLISTs")
warn.AddFlagVar("plist-sort", &gopts.WarnPlistSort, false, "warn about unsorted entries in PLISTs")
warn.AddFlagVar("quoting", &gopts.WarnQuoting, false, "warn about quoting issues")
warn.AddFlagVar("space", &gopts.WarnSpace, false, "warn about inconsistent use of white-space")
warn.AddFlagVar("style", &gopts.WarnStyle, false, "warn about stylistic issues")
warn.AddFlagVar("types", &gopts.WarnTypes, true, "do some simple type checking in Makefiles")
remainingArgs, err := opts.Parse(args)
if err != nil {
fmt.Fprintf(G.logErr, "%s\n\n", err)
opts.Help(G.logErr, "pkglint [options] dir...")
exitcode := 1
return &exitcode
}
gopts.args = remainingArgs
if gopts.PrintHelp {
opts.Help(G.logOut, "pkglint [options] dir...")
exitcode := 0
return &exitcode
}
return nil
}
func (pkglint *Pkglint) PrintSummary() {
if !G.opts.Quiet {
if G.errors != 0 || G.warnings != 0 {
fmt.Fprintf(G.logOut, "%d %s and %d %s found.\n",
G.errors, ifelseStr(G.errors == 1, "error", "errors"),
G.warnings, ifelseStr(G.warnings == 1, "warning", "warnings"))
} else {
io.WriteString(G.logOut, "looks fine.\n")
}
if G.explanationsAvailable && !G.opts.Explain {
fmt.Fprint(G.logOut, "(Run \"pkglint -e\" to show explanations.)\n")
}
if G.autofixAvailable && !G.opts.PrintAutofix && !G.opts.Autofix {
fmt.Fprint(G.logOut, "(Run \"pkglint -fs\" to show what can be fixed automatically.)\n")
}
if G.autofixAvailable && !G.opts.Autofix {
fmt.Fprint(G.logOut, "(Run \"pkglint -F\" to automatically fix some issues.)\n")
}
}
}
|
