golang/go

doc: write Go 1.15 release notes

dmitshur opened this issue · 60 comments

Tracking bug for writing the Go 1.15 Release Notes.

The latest state on tip can be viewed at https://tip.golang.org/doc/go1.15.

Previously #36878, #17929, #15810, #5929, etc.

Change https://golang.org/cl/227997 mentions this issue: doc/go1.15, net/url: document new method URL.Redacted

I think, the changes to the database/... packages should be documented as well:

+pkg database/sql, method (*DB) SetConnMaxIdleTime(time.Duration)
+pkg database/sql, method (*Row) Err() error
+pkg database/sql, type DBStats struct, MaxIdleTimeClosed int64
+pkg database/sql/driver, type Validator interface { IsValid }
+pkg database/sql/driver, type Validator interface, IsValid() bool

Change https://golang.org/cl/235580 mentions this issue: doc/go1.15: document no language changes

Change https://golang.org/cl/235757 mentions this issue: doc: update Go 1.15 release notes using relnote

Change https://golang.org/cl/236157 mentions this issue: doc/go1.15: add release notes for strconv

Change https://golang.org/cl/236158 mentions this issue: doc/go1.15: add release notes for time

Change https://golang.org/cl/236159 mentions this issue: doc/go1.15: release notes for new linker

Change https://golang.org/cl/236160 mentions this issue: doc/go1.15: remove TODOs for tools and go command sections

Change https://golang.org/cl/236162 mentions this issue: doc/go1.15: add release notes for plugin DWARF

Change https://golang.org/cl/236166 mentions this issue: doc/go1.15: add release notes for crypto/tls

Change https://golang.org/cl/236417 mentions this issue: doc/go1.15: add release notes for fmt

Change https://golang.org/cl/236658 mentions this issue: doc/go1.15: add release notes for io/ioutil

Change https://golang.org/cl/236719 mentions this issue: doc/go1.15: exclude spaces from <code> block

Change https://golang.org/cl/236682 mentions this issue: doc/go1.15: mention new debug/pe constants

Change https://golang.org/cl/236718 mentions this issue: doc/go1.15: rationalize runtime sections

Change https://golang.org/cl/236618 mentions this issue: doc/go1.15: document toolchain changes

Change https://golang.org/cl/236599 mentions this issue: cmd/asm, cmd/compile, doc: document -spectre flags

Change https://golang.org/cl/236738 mentions this issue: doc/go1.15: add release notes for regexp

For the Go 1.15 Beta 1 release, we need a complete draft of the release notes (as documented at golang.org/s/release).

I've asked many people to help contribute to the release notes, and there is a lot of progress—thank you everyone for your help with the release and getting the beta 1 out!

There are currently 10 visible TODOs if one does a search at https://tip.golang.org/doc/go1.15:

image

Once they are all resolved, we can proceed with the beta 1 release, and the remaining task here will be to complete the final release notes for the final Go 1.15 release.

Change https://golang.org/cl/236760 mentions this issue: doc/go1.15: remove TODO intended for the Core library section

Change https://golang.org/cl/236523 mentions this issue: doc/go1.15: document two noteworthy json changes

Change https://golang.org/cl/236918 mentions this issue: doc/go1.15: add release notes for crypto and math/big

Change https://golang.org/cl/236737 mentions this issue: doc/go1.15: add release notes for crypto/x509

Change https://golang.org/cl/236921 mentions this issue: doc/go1.15: add more release notes for crypto/tls

Change https://golang.org/cl/237019 mentions this issue: doc/go1.15: add remaining release notes for net/http and net/http/httputil

Change https://golang.org/cl/237157 mentions this issue: doc/go1.15: remove TODO in minor library changes section

As of CL 236739, we now have a complete draft of the eventual release notes for the Go 1.15 release. Thanks to everyone who contributed to reaching this milestone!

What's left here are additional review and editing passes, and filling in any missed changes that we find. These are all okay to do after beta 1, so adding okay-after-beta1 label.

@dmitshur What about the database/sql changes I've mentioned? I can try sending a CL describing them myself, but I'll need someone to recheck my English.

@ainar-g I'm not very familiar with database/sql, but those API additions and the database/sql issues that were resolved in the 1.15 cycle look valuable to be mentioned.

I can try sending a CL describing them myself, but I'll need someone to recheck my English.

Please do send a CL, and add database/sql owners as reviewers. It's very helpful. Thank you!

Change https://golang.org/cl/237397 mentions this issue: doc/go1.15: add release notes for database/sql and database/sql/driver

@dmitshur Done. Hopefully, I didn't bork up the CL numbers.

Change https://golang.org/cl/237539 mentions this issue: doc/go1.15: add code tags

Change https://golang.org/cl/237538 mentions this issue: doc/go1.15: replace tab indentation with spaces

Change https://golang.org/cl/237540 mentions this issue: doc/go1.15: add missing slash

Change https://golang.org/cl/237738 mentions this issue: doc/go1.15: sort debug/pe entry alphabetically

Change https://golang.org/cl/237739 mentions this issue: doc/go1.15: document new bufio.ErrBadReadCount

Change https://golang.org/cl/237740 mentions this issue: doc/go1.15: document go/printer.StdFormat

Change https://golang.org/cl/238139 mentions this issue: doc/go1.15: fix two typos

Change https://golang.org/cl/238240 mentions this issue: doc/go1.15: enumerate ELF-based OSes

Change https://golang.org/cl/238864 mentions this issue: doc/go1.15: mention consequence of os.File.ReadFrom

Change https://golang.org/cl/240201 mentions this issue: doc/go1.15: add release note for encoding/asn1

Change https://golang.org/cl/240518 mentions this issue: doc/go1.15: add encoding/asn1 note about minimal encoding

Change https://golang.org/cl/240546 mentions this issue: doc/go1.15: add html/template and text/template docs

Change https://golang.org/cl/240683 mentions this issue: go/printer: document the StdFormat mode better

Change https://golang.org/cl/241065 mentions this issue: doc/go1.15: update Go 1.15 release notes using relnote

Change https://golang.org/cl/241660 mentions this issue: doc/go1.15: add line for testing streaming change

Change https://golang.org/cl/241740 mentions this issue: doc/go1.15: fix TODO about -buildmode=pie

Change https://golang.org/cl/242903 mentions this issue: doc/go1.15: add release notes for math/cmplx

Change https://golang.org/cl/243137 mentions this issue: doc/go1.15: announce GO386=387 deprecation

Change https://golang.org/cl/243221 mentions this issue: doc/go1.15: surface the crypto/x509 Common Name deprecation note

c-yan commented

The section titled "New warning for impossible interface conversions" is titled "impossible interface conversions", but all the text says "assertions" instead of "conversions".

I feel the title should be rewritten with "assertions" as well, but what do you think?

c-yan commented

I feel that "The goroutine profile includes the profile labels associated with each goroutine at the time of profiling" would be better with "now" before "includes" as in the other text, but what do you think?

RC1 is already out, but the release notes still have the “DRAFT” notice. Should I send a CL to remove that?

The draft notice is correct. We generally remove it as part of making the final release, not earlier.

Change https://golang.org/cl/245977 mentions this issue: doc/go1.15: add code tag

Change https://golang.org/cl/245978 mentions this issue: doc/go1.15: add "now"

Change https://golang.org/cl/245979 mentions this issue: doc/go1.15: add dd's closing tag

Change https://golang.org/cl/247718 mentions this issue: doc/go1.15: encoding/json's CL 191783 was reverted

Change https://golang.org/cl/247772 mentions this issue: doc/go1.15: remove draft notice

Release notes for each major Go release are quite distinct, let's keep using separate tracking issues for tracking all the incoming changes. Closing this issue as done for Go 1.15 (and moving back to Go1.15 milestone).

Made #40700 as the tracking issue for Go 1.16 release notes.