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

Jump to bottom

doc/go1.16: document go command changes for Go 1.16 #42893

Closed
dmitshur opened this issue Nov 30, 2020 · 9 comments
Closed

doc/go1.16: document go command changes for Go 1.16 #42893

dmitshur opened this issue Nov 30, 2020 · 9 comments
Labels
Documentation FrozenDueToAge GoCommand cmd/go NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 release-blocker
Milestone
Go1.16

Comments

@dmitshur
Copy link
Contributor

As of filing this issue, the Go 1.16 draft release notes contained the following HTML:

<h3 id="go-command">Go command</h3>

<p>
  TODO

  <!-- CL 237697: https://golang.org/cl/237697: cmd/go: error when -c or -i are used with unknown flags -->
  <!-- CL 255052: https://golang.org/cl/255052: cmd/go: default to GO111MODULE=on -->
  <!-- CL 266420: https://golang.org/cl/266420: yes (mention go help vcs): cmd/go: add GOVCS setting to control version control usage -->
  <!-- CL 244773: https://golang.org/cl/244773: cmd/go/internal/modload: drop requirements on excluded versions -->
</p>

And these TODOs:

TODO: write and link to section in golang.org/ref/mod
TODO: write and link to blog post
[...]
TODO: write and link to section in golang.org/ref/mod
TODO: write and link to tutorial or blog post

Per golang.org/s/release, it's a release blocker for Go 1.16 Beta 1 to have a complete draft of the eventual release notes, and so the TODO needs to be resolved.

A sequence of steps to resolve this issue may be:

  1. Come up with a draft release note entry in this issue, then move the issue to NeedsFix state.
  2. Send a CL with "doc/go1.16:" prefix and include "For doc: write Go 1.16 release notes #40700. Fixes #{this issue}." in the body.
@dmitshur dmitshur added Documentation help wanted NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. release-blocker labels Nov 30, 2020
@dmitshur dmitshur added this to the Go1.16 milestone Nov 30, 2020
@dmitshur dmitshur added the GoCommand cmd/go label Dec 1, 2020
@bcmills
Copy link
Contributor

bcmills commented Dec 1, 2020

@jayconrod, is this resolved by https://golang.org/cl/274438?

@jayconrod
Copy link
Contributor

Yes, https://golang.org/cl/274438 removed all the TODOs listed here. I saw Alex's email to gophers, but i didn't see this issue.

@matloob I'll leave this issue open for now. Please close it after adding a note for -overlay.

@dmitshur dmitshur changed the title doc/go1.16: resolve go command TODOs in Go 1.16 release notes doc/go1.16: document go command changes for Go 1.16 Dec 3, 2020
@dmitshur
Copy link
Contributor Author

CL 274438 has resolved all user-facing TODOs in the draft 1.16 release notes, so I think the rest of the work on this issue doesn't need to block beta 1.

@dmitshur dmitshur added the okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 label Dec 10, 2020
@jayconrod
Copy link
Contributor

https://golang.org/cl/274438 is merged, so I think we can close this.

@dmitshur
Copy link
Contributor Author

dmitshur commented Dec 10, 2020 •
edited

@jayconrod Has the note for -overlay been added too (as you mentioned in #42893 (comment)), or is it okay not to have an open issue for that? Just want to confirm that it's not missed unintentionally.

@jayconrod
Copy link
Contributor

Oops, I'm sorry, https://go-review.googlesource.com/c/go/+/274714 is the CL adding the -overlay note, and it has not been merged yet, so reopening.

@jayconrod jayconrod reopened this Dec 10, 2020
@gopherbot
Copy link

Change https://golang.org/cl/274714 mentions this issue: cmd/go: add documentation for the -overlay flag

@dolmen
Copy link
Contributor

dolmen commented Feb 11, 2021 •
edited

Is there some reference documentation about the -overlay flag? The not-yet-published 1.16 release notes which mention -overlay doesn't link to documentation about the JSON file structure with example.

@dmitshur
Copy link
Contributor Author

@dolmen The -overlay flag is documented in the not-yet-published 1.16 cmd/go documentation, search for "-overlay" on that page.

@golang golang locked and limited conversation to collaborators Feb 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge GoCommand cmd/go NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 release-blocker
Projects
None yet
Milestone
Go1.16
Development

No branches or pull requests
7 participants
@dolmen @jayconrod @dmitshur @bcmills @gopherbot @matloob and others