Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/go: get subcommand missing help for -v -x flags #58871

Closed
phemmer opened this issue Mar 5, 2023 · 2 comments
Closed

cmd/go: get subcommand missing help for -v -x flags #58871

phemmer opened this issue Mar 5, 2023 · 2 comments
Labels
Documentation GoCommand cmd/go help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@phemmer
Copy link

phemmer commented Mar 5, 2023

What version of Go are you using (go version)?

$ go version
go version go1.20.1 linux/amd64

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
GO111MODULE=""
GOARCH="amd64"
GOBIN="/home/phemmer/.go/bin"
GOCACHE="/home/phemmer/.cache/go-build"
GOENV="/home/phemmer/.config/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/phemmer/.go/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/phemmer/.go:/tmp/go:/home/phemmer/.go:/tmp/go"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.20.1"
GCCGO="gccgo"
GOAMD64="v1"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/dev/null"
GOWORK=""
CGO_CFLAGS="-O2 -g"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-O2 -g"
CGO_FFLAGS="-O2 -g"
CGO_LDFLAGS="-O2 -g"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build265240631=/tmp/go-build -gno-record-gcc-switches"

What did you do?

go help get

What did you expect to see?

Extended documentation which matches the usage

What did you see instead?

Documentation missing on flags listed in the usage, and flags in documentation that are missing in the usage.

the "usage" line shows:

usage: go get [-t] [-u] [-v] [build flags] [packages]

However there is no documentation on what -v is.

Also there is documentation on the -x flag, but this flag is not listed in the usage.

@seankhliao seankhliao changed the title cmd/get: documentation missing/mismatch on flags cmd/go: get subcommand missing help for -v -x flags Mar 5, 2023
@seankhliao seankhliao added NeedsFix The path to resolution is known, but the work has not been done. GoCommand cmd/go labels Mar 5, 2023
@bcmills
Copy link
Member

bcmills commented Mar 6, 2023

-x and -v are included in the [build flags] section.

Most other commands that accept build flags say “For more about build flags, see 'go help build'.” However, it appears that that sentence is missing for module-mode go get.

@bcmills bcmills added this to the Backlog milestone Mar 6, 2023
@gopherbot
Copy link

Change https://go.dev/cl/474375 mentions this issue: cmd/go: unify the format of the go help xxx command

@dmitshur dmitshur modified the milestones: Backlog, Go1.21 May 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation GoCommand cmd/go help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

5 participants