]> Cypherpunks repositories - gostls13.git/commit
runtime/pprof: document use of pprof package
authorAustin Clements <austin@google.com>
Mon, 25 Jul 2016 17:41:07 +0000 (13:41 -0400)
committerAustin Clements <austin@google.com>
Tue, 26 Jul 2016 22:16:55 +0000 (22:16 +0000)
commitb11fff3886705bd98aec4923f43216ed8e13cb1a
treee83c684f3d38533c23ab0c19c5ddb65f04871e43
parentff60da6962f71871fac3dd6a5406686ea92de8dc
runtime/pprof: document use of pprof package

Currently the pprof package gives almost no guidance for how to use it
and, despite the standard boilerplate used to create CPU and memory
profiles, this boilerplate appears nowhere in the pprof documentation.

Update the pprof package documentation to give the standard
boilerplate in a form people can copy, paste, and tweak. This
boilerplate is based on rsc's 2011 blog post on profiling Go programs
at https://blog.golang.org/profiling-go-programs, which is where I
always go when I need to copy-paste the boilerplate.

Change-Id: I74021e494ea4dcc6b56d6fb5e59829ad4bb7b0be
Reviewed-on: https://go-review.googlesource.com/25182
Reviewed-by: Rick Hudson <rlh@golang.org>
src/runtime/pprof/pprof.go