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: GOCACHEPROG needs real documentation #71032

Closed
aclements opened this issue Dec 26, 2024 · 7 comments
Closed

cmd/go: GOCACHEPROG needs real documentation #71032

aclements opened this issue Dec 26, 2024 · 7 comments
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. release-blocker
Milestone

Comments

@aclements
Copy link
Member

GOCACHEPROG will be enabled by default in Go 1.24. Currently, the only documentation on this appears to be #59719 (comment), which is quite terse and not completely up-to-date.

We should add a real documentation page on this setting and the protocol, probably to the cmd/go documentation. Once we've done this, we should also update the 1.24 release notes to point to the documentation instead of #59719.

@aclements aclements added this to the Go1.24 milestone Dec 26, 2024
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Dec 26, 2024
@gabyhelp
Copy link

@cherrymui cherrymui added NeedsFix The path to resolution is known, but the work has not been done. GoCommand cmd/go labels Dec 27, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/638567 mentions this issue: cmd/go: add "go help gocacheprog" topic

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/638566 mentions this issue: cmd/go: improve GOCACHEPROG types documentation

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/638996 mentions this issue: cmd/go/internal/cacheprog: drop redundant Prog prefixes

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/638995 mentions this issue: cmd/go: move GOCACHEPROG protocol types to their own package

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/638997 mentions this issue: cmd/go: document GOCACHEPROG in go help environment

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/638378 mentions this issue: _content/doc/go1.24: link to in-tree GOCACHEPROG docs

gopherbot pushed a commit that referenced this issue Jan 2, 2025
This is in preparation for adding a "go help" topic for GOCACHEPROG.

Updates #71032
Updates #59719

Change-Id: I9dbbe56fa328dffe89207b5b41a0f37afd51e2b5
Reviewed-on: https://go-review.googlesource.com/c/go/+/638566
LUCI-TryBot-Result: Go LUCI <[email protected]>
Auto-Submit: Austin Clements <[email protected]>
Reviewed-by: Michael Matloob <[email protected]>
gopherbot pushed a commit that referenced this issue Jan 2, 2025
This is a step toward making it easy to point to them in
documentation. The other option is that we copy-paste all of these
type definitions wholesale, which seems ridiculous.

Updates #71032
Updates #59719

Change-Id: I7117e03308ae0adc721ed7a57792c33ba68ce827
Reviewed-on: https://go-review.googlesource.com/c/go/+/638995
Auto-Submit: Austin Clements <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Michael Matloob <[email protected]>
gopherbot pushed a commit that referenced this issue Jan 2, 2025
Now that these types are in their own package, drop the unnecessary
Prog prefixes from everything.

Updates #71032
Updates #59719

Change-Id: Id54edf0473754e3b21a71beb72803fb5481206c1
Reviewed-on: https://go-review.googlesource.com/c/go/+/638996
Reviewed-by: Mauri de Souza Meneguzzo <[email protected]>
Reviewed-by: Michael Matloob <[email protected]>
Reviewed-by: Brad Fitzpatrick <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Auto-Submit: Austin Clements <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
gopherbot pushed a commit to golang/website that referenced this issue Jan 2, 2025
Currently the release notes link to the proposal for GOCACHEPROG,
which isn't ideal and is also slightly outdated. CL 638995 moves the
protocol documentation to its own package that we can link to and that
can't get out of date, so point the release notes at this
documentation.

For golang/go#71032

Change-Id: I8d4db0a0153333b40f9021f030a36184546bfe51
Reviewed-on: https://go-review.googlesource.com/c/website/+/638378
Auto-Submit: Austin Clements <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
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. release-blocker
Projects
None yet
Development

No branches or pull requests

4 participants