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: missing flags in help output for tool #71502

Closed
howardjohn opened this issue Jan 31, 2025 · 5 comments
Closed

cmd/go: missing flags in help output for tool #71502

howardjohn opened this issue Jan 31, 2025 · 5 comments
Assignees
Labels
Documentation Issues describing a change to documentation. GoCommand cmd/go NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@howardjohn
Copy link
Contributor

Go version

latest

Output of go env in your module/workspace:

N/A

What did you do?

go help tool

What did you see happen?

No mention of -modfile

What did you expect to see?

Available flags are documented. Given the issues around default modfile sharing with the tools and the main project, using alternative mod files is likely to be very common. Documenting the flags available will ensure users do not reach to weird workarounds rather than just do -modfile=tools/go.mod or similar.

@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Jan 31, 2025
@seankhliao seankhliao changed the title cmd/tool: missing documentation on -modfile cmd/go: missing flags in help output Jan 31, 2025
@seankhliao seankhliao added this to the Go1.24 milestone Jan 31, 2025
@seankhliao
Copy link
Member

There are some additional flags:

  • -C
  • -modcacherw
  • -modfile
  • -overlay

@seankhliao seankhliao added the GoCommand cmd/go label Jan 31, 2025
@seankhliao seankhliao changed the title cmd/go: missing flags in help output cmd/go: missing flags in help output for tool Jan 31, 2025
@cagedmantis cagedmantis added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jan 31, 2025
@cagedmantis
Copy link
Contributor

cc @matloob @samthanawalla

@thepudds thepudds self-assigned this Jan 31, 2025
@thepudds
Copy link
Contributor

I'll take a crack at this unless someone else would prefer to do it themselves. (I have a couple of related small WIP doc & help CLs for the new go tool feature; I'll likely open up a separate issue for those).

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/648577 mentions this issue: cmd/go: document -modfile and other flags for 'go tool'

@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues describing a change to documentation. GoCommand cmd/go NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

7 participants