Skip to content

Commit a3c6ea7

Browse files
authored
docs(README.md): Add abspath, mod, and ignoregenerated flag docs (#220)
Noticed that some useful flags were not documented in the README.md. I've added the these in what I think are the relevant sections. I did a minimal explanation of the flags, but can expand on them. I erred on the side of not expanding on -ignoregenerated for example because the regex might change in the future, and documentation tends to be a forgotten update...
1 parent 3faf0bc commit a3c6ea7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ takes no arguments.
3636
The `-blank` flag enables checking for assignments of errors to the
3737
blank identifier. It takes no arguments.
3838

39+
The `-abspath` flag prints the absolute paths to files with unchecked errors.
40+
41+
The `-mod` flag sets the module download mode to use: `readonly` or `vendor`.
42+
3943
### go/analysis
4044

4145
The package provides `Analyzer` instance that can be used with
@@ -120,6 +124,8 @@ specified for it. To disable this, specify a regex that matches nothing:
120124
The `-ignoretests` flag disables checking of `_test.go` files. It takes
121125
no arguments.
122126

127+
The `-ignoregenerated` flag disables checking of generated source code. It takes no arguments.
128+
123129
## Exit Codes
124130

125131
errcheck returns 1 if any problems were found in the checked files.

0 commit comments

Comments
 (0)