e596e88318
Add the Localize function, which takes an io/fs slash-separated path and returns an operating system path. Localize returns an error if the path cannot be represented on the current platform. Replace internal/safefile.FromFS with Localize, which serves the same purpose as this function. The internal/safefile package remains separate from path/filepath to avoid a dependency cycle with the os package. Fixes #57151 Change-Id: I75c88047ddea17808276761da07bf79172c4f6fc Reviewed-on: https://go-review.googlesource.com/c/go/+/531677 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Ian Lance Taylor <iant@google.com> |
||
---|---|---|
.. | ||
initial | ||
next | ||
asm.html | ||
go1.17_spec.html | ||
go_mem.html | ||
go_spec.html | ||
godebug.md | ||
README.md |
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.
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`](/pkg/net/http#Request) # symbol documentation
[#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.