runtime/pprof: document that profile names should not contain spaces.

Change-Id: I967d897e812bee63b32bc2a7dcf453861b89b7e3
Reviewed-on: https://go-review.googlesource.com/36533
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>

diff --git a/src/runtime/pprof/pprof.go b/src/runtime/pprof/pprof.go
index 8c500e6f3eb322e2936d007e85d12b8dc3407a5e..c2b4a2787eabcf95723b65e43d5a051e88da9ae7 100644 (file)
--- a/src/runtime/pprof/pprof.go
+++ b/src/runtime/pprof/pprof.go
@@ -185,6 +185,8 @@ func unlockProfiles() {
 // If a profile with that name already exists, NewProfile panics.
 // The convention is to use a 'import/path.' prefix to create
 // separate name spaces for each package.
+// For compatibility with various tools that read pprof data,
+// profile names should not contain spaces.
 func NewProfile(name string) *Profile {
        lockProfiles()
        defer unlockProfiles()