Skip to content

Commit 76e9546

Browse files
julieqiugopherbot
authored andcommitted
internal/scan: update govulncheck docs
Update docs for the `govulncheck -show` and `govulncheck -scan` flags. Change-Id: I4961c8ba993c21bbca942fee26a6e341e87dec8c Reviewed-on: https://go-review.googlesource.com/c/vuln/+/508918 Auto-Submit: Julie Qiu <julieqiu@google.com> Reviewed-by: Ian Cottrell <iancottrell@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Julie Qiu <julieqiu@google.com> Run-TryBot: Julie Qiu <julieqiu@google.com>
1 parent 1f1cc7a commit 76e9546

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

cmd/govulncheck/testdata/usage.ct

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ Usage:
1616
output JSON
1717
-mode string
1818
supports source or binary (default "source")
19-
-scan-level string
19+
-scan string
2020
set the scanning level desired, one of module, package or symbol (default "symbol")
2121
-show list
22-
enable display of additional information specified by list
22+
enable display of additional information specified by the comma separated list
23+
The only supported value is 'traces'
2324
-tags list
2425
comma-separated list of build tags
2526
-test
@@ -45,10 +46,11 @@ Usage:
4546
output JSON
4647
-mode string
4748
supports source or binary (default "source")
48-
-scan-level string
49+
-scan string
4950
set the scanning level desired, one of module, package or symbol (default "symbol")
5051
-show list
51-
enable display of additional information specified by list
52+
enable display of additional information specified by the comma separated list
53+
The only supported value is 'traces'
5254
-tags list
5355
comma-separated list of build tags
5456
-test

internal/scan/flags.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ func parseFlags(cfg *config, stderr io.Writer, args []string) error {
4747
flags.StringVar(&cfg.db, "db", "https://vuln.go.dev", "vulnerability database `url`")
4848
flags.StringVar(&cfg.mode, "mode", modeSource, "supports source or binary")
4949
flags.Var(&tagsFlag, "tags", "comma-separated `list` of build tags")
50-
flags.Var(&showFlag, "show", "enable display of additional information specified by `list`")
51-
scanLevel := flags.String("scan-level", "symbol", "set the scanning level desired, one of module, package or symbol")
50+
flags.Var(&showFlag, "show", "enable display of additional information specified by the comma separated `list`\nThe only supported value is 'traces'")
51+
scanLevel := flags.String("scan", "symbol", "set the scanning level desired, one of module, package or symbol")
5252
flags.Usage = func() {
5353
fmt.Fprint(flags.Output(), `Govulncheck reports known vulnerabilities in dependencies.
5454

0 commit comments

Comments
 (0)