...

Text file src/cmd/pprof/README

Documentation: cmd/pprof

     1This directory is the copy of Google's pprof shipped as part of the Go distribution.
     2The bulk of the code is vendored from github.com/google/pprof and is in
     3../vendor/github.com/google/pprof.
     4
     5Two important notes:
     6
     71. Using github.com/google/pprof directly (for example, after installing
     8with "go get") should work with Go programs, but we cannot guarantee that.
     9What we test is that the "go tool pprof" shipped with each Go release works
    10with programs from that release.
    11
    122. Pprof is used inside Google for C++, Java, and Go programs.
    13Because it was developed for that broader context, it is overgeneralized
    14when used here for the specific use case of profiling standard Go programs.
    15However, we've left the abstractions intact in order to share updates
    16between our vendored copy and Google's internal one.
    17Please do not take the level of abstraction in this program as an example
    18to follow in your own.

View as plain text