doc: write Go 1.14 release notes
dmitshur opened this issue · 50 comments
Tracking bug for writing the Go 1.14 Release Notes.
The latest state on tip can be viewed at https://tip.golang.org/doc/go1.14.
Change https://golang.org/cl/216997 mentions this issue: doc/go1.14: document overlapping interfaces change (update release notes)
Change https://golang.org/cl/217099 mentions this issue: doc: document new hash/maphash package
Change https://golang.org/cl/217100 mentions this issue: doc/go1.14: fix minot typo (update release notes)
Change https://golang.org/cl/217122 mentions this issue: doc/go1.14: mime: .js files now text/javascript
Change https://golang.org/cl/217067 mentions this issue: doc/go1.14: mention that debug/dwarf now supports DWARF 5
Change https://golang.org/cl/217123 mentions this issue: doc/go1.14: mention new method encoding/json.Decoder.InputOffset
Change https://golang.org/cl/217124 mentions this issue: doc/go1.14: mention new field go/build.Context.Dir
Change https://golang.org/cl/217125 mentions this issue: doc/go1.14: mention go/doc.NewFromFiles and associated new data fields
Change https://golang.org/cl/217126 mentions this issue: doc/go1.14: mention new log.Lmsgprefix flag
Change https://golang.org/cl/217127 mentions this issue: doc/go1.14: mention new math/bits functions Rem, Rem32, Rem64
Change https://golang.org/cl/217128 mentions this issue: doc/go1.14: mention new method mime/multipart.(*Reader).NextRawPart
Change https://golang.org/cl/217129 mentions this issue: doc/go1.14: mention net/http.Header.Values, net/textproto.MIMEHeader.Values
Change https://golang.org/cl/217130 mentions this issue: doc/go1.14: mention new field Transport.DialTLSContext
Change https://golang.org/cl/217131 mentions this issue: doc/go1.14: mention new field net/http/httptest/Server.EnableHTTP2
Change https://golang.org/cl/217132 mentions this issue: doc/go1.14: mention new method strconv.NumError.Unwrap
Change https://golang.org/cl/217133 mentions this issue: doc/go1.14: mention update to Unicode 12
Change https://golang.org/cl/217277 mentions this issue: doc/go1.14: move "Minor changes to the library" heading up
Change https://golang.org/cl/217358 mentions this issue: doc/go1.14: remove TODO about Dragonfly passing
@sergeilem You've worked on adding support for ASN1's string type BMPString in CL 126624. Would you like to send a CL to describe that change in the Go 1.14 release notes?
Edit: I've attempted to describe it in CL 217637, maybe you could review it. Thanks.
Change https://golang.org/cl/217637 mentions this issue: doc/go1.14: document encoding/asn1 support for BMPString
Change https://golang.org/cl/217640 mentions this issue: doc/go1.14: note that all changes to the standard library are minor
Change https://golang.org/cl/217737 mentions this issue: doc/go1.14: remove TODO about Illumos port
Change https://golang.org/cl/217738 mentions this issue: doc/go1.14: remove TODO about Solaris port
Change https://golang.org/cl/217797 mentions this issue: doc: rename HTML element IDs to avoid duplicates
Change https://golang.org/cl/217701 mentions this issue: doc/go1.14: fix inconsistent markup
Change https://golang.org/cl/217779 mentions this issue: doc/go1.14: document http.ServeFile large file fix for Windows
Change https://golang.org/cl/217780 mentions this issue: doc/go1.14: document io/ioutil.TempDir's predictable prefix+suffix
Change https://golang.org/cl/217978 mentions this issue: doc/go1.14: mention better error checking in text/template
Is doc/go1.14 of master branch broken?
https://tip.golang.org/doc/go1.14
template: main:846: unexpected EOF
Change https://golang.org/cl/218297 mentions this issue: hash/maphash: mention that hash values do not persist in package docs
Change https://golang.org/cl/218637 mentions this issue: doc/go1.14: add link to TempFile in io/ioutil
Change https://golang.org/cl/218638 mentions this issue: doc/go1.14: rearrange in alphabetical order
Change https://golang.org/cl/218918 mentions this issue: doc/go1.14: add a couple minor crypto release notes
Should "context got faster" also be in the release notes?
https://go-review.googlesource.com/c/go/+/196521
@posener It doesn't seem necessary to me. There are many performance improvements. This one doesn't seem worth calling out specially; I doubt it would cause anybody to change their programming patterns.
I plan to send a CL to highlight the hash/maphash package as a more noteworthy change to the standard library, rather than letting it stay in the middle of "Minor changes to the library" section. It is a new package that did not exist before, so my understanding is that it should be called out. For example, Go 1.13 release notes called out the new crypto/ed25519, and Go 1.9 release notes called out the new math/bits.
Does anyone agree or disagree?
Edit: Sent CL 219877.
Change https://golang.org/cl/219877 mentions this issue: doc/go1.14: highlight the addition of hash/maphash package
I noticed we overlooked a TODO in a comment in the Go 1.14 release notes (only visible when viewing source):
<!-- TODO: Maybe CL 200439? -->
We should resolve that TODO either by mentioning that CL in the Go 1.14 release notes, or not doing that and deleting the "maybe" comment.
@mknyszek @aclements Do you have an opinion on which is better?
<!-- TODO: Maybe CL 200439? -->
I'm inclined to not mention this. I think explaining this is just too subtle and it shouldn't affect many users. Unless, @mknyszek, do you think you could come up with a straightforward user-facing explanation of the consequences of that change?
@aclements I think you're right, and I cannot. I don't want to discourage users from filings bugs about changes in their application's behavior (especially if its for the worse) by implying that the runtime got slower in exchange for memory use, and I can't think of a straight-forward wording that doesn't have this connotation.
Change https://golang.org/cl/219898 mentions this issue: doc/go1.14: remove TODO comment for CL 200439
Change https://golang.org/cl/220646 mentions this issue: doc/go1.14: remove draft notice
Change https://golang.org/cl/220650 mentions this issue: [release-branch.go1.14] doc/go1.14: remove draft notice
Change https://golang.org/cl/220906 mentions this issue: doc/go1.14: add link to module migration guide
Change https://golang.org/cl/220981 mentions this issue: [release-branch.go1.14] doc/go1.14: add link to module migration guide
Change https://golang.org/cl/222037 mentions this issue: doc/go1.14: document that unparsable URL in net/url/Error is now quoted
Change https://golang.org/cl/222317 mentions this issue: [release-branch.go1.14] doc/go1.14: document that unparsable URL in net/url.Error is now quoted
Change https://golang.org/cl/223962 mentions this issue: [release-branch.go1.14] doc/go1.14: mention Windows change for Open permissions