1
0
mirror of https://github.com/golang/go synced 2024-11-15 02:10:21 -07:00
go/doc
Russ Cox 6ccd8e4cf6 cmd/go: add support for godebug lines in go.mod and go.work
The fact that the go line sets both the language version and the
GODEBUG compatibility version can be a problem, especially since
the go line is also required to be ≥ the go lines of any required
dependency modules.

This change adds a new 'godebug' line to go.mod and go.work
to allow setting the GODEBUG values for the entire module.

It also adds a new meta-value default=go1.21 that means
take the defaults from Go 1.21 no matter what the go line says.

These were discussed in proposal #65573.

Fixes #65573.

Change-Id: I91746322a10178370ed1015ce5278372a024c824
Reviewed-on: https://go-review.googlesource.com/c/go/+/584476
Auto-Submit: Russ Cox <rsc@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Sam Thanawalla <samthanawalla@google.com>
Reviewed-by: Michael Matloob <matloob@golang.org>
2024-05-15 13:52:10 +00:00
..
initial doc/initial: initial contents of release notes 2024-01-22 18:07:49 +00:00
next doc: add relnote fragment on stack slot merging 2024-05-14 17:18:10 +00:00
asm.html doc: document PCALIGN directive 2023-11-28 19:15:27 +00:00
go1.17_spec.html all: consistently use "IEEE 754" over "IEEE-754" 2024-04-11 20:22:45 +00:00
go_mem.html doc: close HTML tags 2024-03-04 15:54:42 +00:00
go_spec.html spec: clarify when range expression is evaluated 2024-05-02 22:43:51 +00:00
godebug.md cmd/go: add support for godebug lines in go.mod and go.work 2024-05-15 13:52:10 +00:00
README.md doc/README.md: discourage RELNOTE in CLs 2024-04-26 21:24:36 +00:00

Release Notes

The initial and next subdirectories of this directory are for release notes.

For developers

Release notes should be added to next by editing existing files or creating new files. Do not add RELNOTE=yes comments in CLs. Instead, add a file to the CL (or ask the author to do so).

At the end of the development cycle, the files will be merged by being concatenated in sorted order by pathname. Files in the directory matching the glob "*stdlib/*minor" are treated specially. They should be in subdirectories corresponding to standard library package paths, and headings for those package paths will be generated automatically.

Files in this repo's api/next directory must have corresponding files in doc/next/*stdlib/*minor. The files should be in the subdirectory for the package with the new API, and should be named after the issue number of the API proposal. For example, if the directory 6-stdlib/99-minor is present, then an api/next file with the line

pkg net/http, function F #12345

should have a corresponding file named doc/next/6-stdlib/99-minor/net/http/12345.md. At a minimum, that file should contain either a full sentence or a TODO, ideally referring to a person with the responsibility to complete the note.

Use the following forms in your markdown:

[http.Request]                     # symbol documentation; auto-linked as in Go doc strings
[#12345](/issue/12345)             # GitHub issues
[CL 6789](/cl/6789)                # Gerrit changelists

For the release team

At the start of a release development cycle, the contents of next should be deleted and replaced with those of initial. From the repo root:

> cd doc
> rm -r next/*
> cp -r initial/* next

Then edit next/1-intro.md to refer to the next version.

To prepare the release notes for a release, run golang.org/x/build/cmd/relnote generate. That will merge the .md files in next into a single file.