1b9dc3e178
The current stack depth limit for alloc, mutex, block, threadcreate and goroutine profiles of 32 frequently leads to truncated stack traces in production applications. Increase the limit to 128 which is the same size used by the execution tracer. Create internal/profilerecord to define variants of the runtime's StackRecord, MemProfileRecord and BlockProfileRecord types that can hold arbitrarily big stack traces. Implement internal profiling APIs based on these new types and use them for creating protobuf profiles and to act as shims for the public profiling APIs using the old types. This will lead to an increase in memory usage for applications that use the impacted profile types and have stack traces exceeding the current limit of 32. Those applications will also experience a slight increase in CPU usage, but this will hopefully soon be mitigated via CL 540476 and 533258 which introduce frame pointer unwinding for the relevant profile types. For #43669. Change-Id: Ie53762e65d0f6295f5d4c7d3c87172d5a052164e Reviewed-on: https://go-review.googlesource.com/c/go/+/572396 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Austin Clements <austin@google.com> Reviewed-by: Cherry Mui <cherryyz@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. 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.
If your CL addresses an accepted proposal, mention the proposal issue number in
your release note in the form /issue/NUMBER
. A link to the issue in the text
will have this form (see below). If you don't want to mention the issue in the
text, add it as a comment:
<!-- go.dev/issue/12345 -->
If an accepted proposal is mentioned in a CL but not in the release notes, it will be flagged as a TODO by the automated tooling. That is true even for proposals that add API.
Use the following forms in your markdown:
[http.Request] # symbol documentation; auto-linked as in Go doc strings
[Request] # short form, for symbols in the package being documented
[#12345](/issue/12345) # GitHub issues
[CL 6789](/cl/6789) # Gerrit changelists
For the release team
The relnote
tool, at golang.org/x/build/cmd/relnote
, operates on the files
in doc/next
.
As a release cycle nears completion, run relnote todo
to get a list of
unfinished release note work.
To prepare the release notes for a release, run relnote generate
.
That will merge the .md
files in next
into a single file.
To begin the next release development cycle, delete the contents of next
and replace them 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.