mirror of
https://github.com/golang/go
synced 2024-11-19 21:04:43 -07:00
runtime/pprof: document content of heap profile
Fixes #11343. Change-Id: I46efc24b687b9d060ad864fbb238c74544348e38 Reviewed-on: https://go-review.googlesource.com/12556 Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
parent
9d56c1813e
commit
6b8762104a
@ -41,6 +41,13 @@ import (
|
||||
// These predefined profiles maintain themselves and panic on an explicit
|
||||
// Add or Remove method call.
|
||||
//
|
||||
// The heap profile reports statistics as of the most recently completed
|
||||
// garbage collection; it elides more recent allocation to avoid skewing
|
||||
// the profile away from live data and toward garbage.
|
||||
// If there has been no garbage collection at all, the heap profile reports
|
||||
// all known allocations. This exception helps mainly in programs running
|
||||
// without garbage collection enabled, usually for debugging purposes.
|
||||
//
|
||||
// The CPU profile is not available as a Profile. It has a special API,
|
||||
// the StartCPUProfile and StopCPUProfile functions, because it streams
|
||||
// output to a writer during profiling.
|
||||
|
Loading…
Reference in New Issue
Block a user