Skip to content

Commit

Permalink
Doc security tag is disabled and fails if enabled
Browse files Browse the repository at this point in the history
Document that the security tag is disabled by default. Also document
that there are currently no checks in the security tag, so enabling it
will fail.

$ ./gocritic check -v -enable='#security
init checkers: empty checkers set selected
$ echo $?
1

When trying to enable the tag through golangci-lint, this is the error:

ERRO Invalid gocritic settings: gocritic [enabled]tag "security" doesn't
exist

The tag was added in #989.

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
  • Loading branch information
dfarrell07 committed Feb 1, 2022
1 parent 352ed07 commit 65cbfc0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -109,7 +109,7 @@ Tags:
* `#performance` - kind of checks that detect potential performance issues in code
* `#experimental` - check is under testing and development. Disabled by default
* `#opinionated` - check can be unwanted for some people. Disabled by default
* `#security` - kind of checks that find security issues in code
* `#security` - kind of checks that find security issues in code. Disabled by default and empty, so will fail if enabled.

## Contributing

Expand Down

0 comments on commit 65cbfc0

Please sign in to comment.