1
0
mirror of https://github.com/golang/go synced 2024-11-19 07:14:45 -07:00

runtime/debug: clarify WriteHeapDump STW behavior

Change-Id: I049d2596fe8ce0e93391599f5c224779fd8e316f
Reviewed-on: https://go-review.googlesource.com/20761
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
Alan Donovan 2016-03-16 12:57:17 -04:00
parent 9f301643bd
commit ed73efbb74

View File

@ -155,6 +155,12 @@ func SetPanicOnFault(enabled bool) bool {
// WriteHeapDump writes a description of the heap and the objects in
// it to the given file descriptor.
//
// WriteHeapDump suspends the execution of all goroutines until the heap
// dump is completely written. Thus, the file descriptor must not be
// connected to a pipe or socket whose other end is in the same Go
// process; instead, use a temporary file or network socket.
//
// The heap dump format is defined at https://golang.org/s/go15heapdump.
func WriteHeapDump(fd uintptr)