1
0
mirror of https://github.com/golang/go synced 2024-11-22 20:24:47 -07:00
go/doc
Alan Donovan 1bb947b2eb runtime/debug: SetCrashOutput sets the FD for fatal panics
This feature makes it possible to record unhandled panics
in any goroutine through a watchdog process (e.g. the same
application forked+exec'd as a child in a special mode)
that can process the panic report, for example by sending
it to a crash-reporting system such as Go telemetry
or Sentry.

Fixes #42888

Change-Id: I5aa7be8f726bbc70fc650540bd1a14ab60c62ecb
Reviewed-on: https://go-review.googlesource.com/c/go/+/547978
Reviewed-by: Michael Pratt <mpratt@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Alan Donovan <adonovan@google.com>
Reviewed-by: Russ Cox <rsc@golang.org>
2024-01-31 16:50:42 +00:00
..
initial doc/initial: initial contents of release notes 2024-01-22 18:07:49 +00:00
next runtime/debug: SetCrashOutput sets the FD for fatal panics 2024-01-31 16:50:42 +00:00
asm.html doc: document PCALIGN directive 2023-11-28 19:15:27 +00:00
go1.17_spec.html doc: in pre-generic spec, be explicit that it is not the current spec 2023-12-13 20:38:46 +00:00
go1.22.html doc/go1.22: remove archive/tar.FileInfoNames 2024-01-24 20:57:42 +00:00
go_mem.html doc: fix html tags 2023-08-03 14:43:29 +00:00
go_spec.html spec: clarify iteration variable type for range over integer 2024-01-30 23:08:51 +00:00
godebug.md crypto/x509: gate Policies marshaling with GODEBUG 2023-12-11 23:29:45 +00:00
README.md doc/README: clarify instructions 2024-01-30 20:08:43 +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.

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.