Commit ed73efbb authored by Alan Donovan's avatar Alan Donovan

runtime/debug: clarify WriteHeapDump STW behavior

Change-Id: I049d2596fe8ce0e93391599f5c224779fd8e316f
Reviewed-on: https://go-review.googlesource.com/20761Reviewed-by: default avatarBrad Fitzpatrick <bradfitz@golang.org>
parent 9f301643
...@@ -155,6 +155,12 @@ func SetPanicOnFault(enabled bool) bool { ...@@ -155,6 +155,12 @@ func SetPanicOnFault(enabled bool) bool {
// WriteHeapDump writes a description of the heap and the objects in // WriteHeapDump writes a description of the heap and the objects in
// it to the given file descriptor. // 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. // The heap dump format is defined at https://golang.org/s/go15heapdump.
func WriteHeapDump(fd uintptr) func WriteHeapDump(fd uintptr)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment