]> Cypherpunks repositories - gostls13.git/commit
cmd/vet: improve documentation for flags, slightly
authorRob Pike <r@golang.org>
Mon, 4 Apr 2016 20:22:34 +0000 (13:22 -0700)
committerRob Pike <r@golang.org>
Mon, 11 Apr 2016 22:35:22 +0000 (22:35 +0000)
commitd1feddb7ae6389ee4175ee85b7168cf58a04b952
tree2dc1b4ac2b03ddbb139b03c5afce39c7a5b80194
parenta4650a2111b2bb826ca64a13bdad9c96e3095e47
cmd/vet: improve documentation for flags, slightly

The way that -all works was unclear from the documentation and made
worse by recent changes to the flag package. Improve matters by making
the help message say "default true" for the tests that do default to true,
and tweak some of the wording.

Before:

Usage of vet:
vet [flags] directory...
vet [flags] files... # Must be a single package
For more information run
go doc cmd/vet

Flags:
  -all
     enable all non-experimental checks (default unset)
  -asmdecl
     check assembly against Go declarations (default unset)
...

After:

Usage of vet:
vet [flags] directory...
vet [flags] files... # Must be a single package
By default, -all is set and all non-experimental checks are run.
For more information run
go doc cmd/vet

Flags:
  -all
     enable all non-experimental checks (default true)
  -asmdecl
     check assembly against Go declarations (default true)
...

Change-Id: Ie94b27381a9ad2382a10a7542a93bce1d59fa8f5
Reviewed-on: https://go-review.googlesource.com/21495
Reviewed-by: Andrew Gerrand <adg@golang.org>
src/cmd/vet/doc.go
src/cmd/vet/main.go