1
0
mirror of https://github.com/golang/go synced 2024-11-24 21:10:04 -07:00

cmd/go: expand help text for go mod tidy

`go mod tidy` will ignore files with the build constraint `ignore`. This
is documented in https://go.dev/ref/mod#go-mod-tidy. While this URL in
mentioned in the existing help text, the fact about the special handling
of the `ignore` tag is significant enough to be mentioned explicitly in
the help text. From the existing link it's not inmediately obvious that
this special behavior exists.

Take most of the relevant text from the online description and add it to
the help text of `go mod tidy`.

Fixes: #54993
Signed-off-by: Marcelo E. Magallon <marcelo.magallon@gmail.com>
This commit is contained in:
Marcelo E. Magallon 2022-09-10 15:05:53 -06:00
parent d5de62df15
commit dc73bc1f98
2 changed files with 6 additions and 0 deletions

View File

@ -1319,6 +1319,9 @@
//
// The -x flag causes tidy to print the commands download executes.
//
// Tidy treats all build constraints except 'ignore' as satisfied, including
// implicit constraints from filenames.
//
// See https://golang.org/ref/mod#go-mod-tidy for more about 'go mod tidy'.
//
// # Make vendored copy of dependencies

View File

@ -50,6 +50,9 @@ file.
The -x flag causes tidy to print the commands download executes.
Tidy treats all build constraints except 'ignore' as satisfied, including
implicit constraints from filenames.
See https://golang.org/ref/mod#go-mod-tidy for more about 'go mod tidy'.
`,
Run: runTidy,