]> Cypherpunks repositories - gostls13.git/commitdiff
runtime/pprof: document content of heap profile
authorRuss Cox <rsc@golang.org>
Thu, 23 Jul 2015 04:14:33 +0000 (00:14 -0400)
committerRuss Cox <rsc@golang.org>
Mon, 27 Jul 2015 16:30:27 +0000 (16:30 +0000)
Fixes #11343.

Change-Id: I46efc24b687b9d060ad864fbb238c74544348e38
Reviewed-on: https://go-review.googlesource.com/12556
Reviewed-by: Rob Pike <r@golang.org>
src/runtime/pprof/pprof.go

index 7d888e4ab0db2e7a4661c2a5d8e25e0f8aba1f41..23fc85093b0224b513ca5d57e8a13036732f644f 100644 (file)
@@ -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.