From: Rob Pike <r@golang.org>
Date: Wed, 13 Mar 2013 20:56:51 +0000 (-0700)
Subject: cmd/go: better documentation about profiling
X-Git-Tag: go1.1rc2~523
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=221163411312443b5e13c17382a101a94bd2db62;p=gostls13.git

cmd/go: better documentation about profiling
Point the user to "go tool pprof" and mention some
important flags.

Fixes #4990.

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/7657045
---

diff --git a/src/cmd/go/doc.go b/src/cmd/go/doc.go
index bf5be6ad02..eab54abe62 100644
--- a/src/cmd/go/doc.go
+++ b/src/cmd/go/doc.go
@@ -685,6 +685,11 @@ Description of testing flags
 The 'go test' command takes both flags that apply to 'go test' itself
 and flags that apply to the resulting test binary.
 
+Several of the flags control profiling and write an execution profile
+suitable for "go tool pprof"; run "go tool pprof help" for more
+information.  The --alloc_space, --alloc_objects, and --show_bytes
+options of pprof control how the information is presented.
+
 The following flags are recognized by the 'go test' command and
 control the execution of any test:
 
@@ -722,8 +727,8 @@ control the execution of any test:
 	    Write a CPU profile to the specified file before exiting.
 
 	-memprofile mem.out
-	    Write a memory profile to the specified file when all tests
-	    are complete.
+	    Write a memory profile to the specified file after all tests
+	    have passed.
 
 	-memprofilerate n
 	    Enable more precise (and expensive) memory profiles by setting
diff --git a/src/cmd/go/test.go b/src/cmd/go/test.go
index 3132ab2100..de69efe8f2 100644
--- a/src/cmd/go/test.go
+++ b/src/cmd/go/test.go
@@ -81,6 +81,11 @@ var helpTestflag = &Command{
 The 'go test' command takes both flags that apply to 'go test' itself
 and flags that apply to the resulting test binary.
 
+Several of the flags control profiling and write an execution profile
+suitable for "go tool pprof"; run "go tool pprof help" for more
+information.  The --alloc_space, --alloc_objects, and --show_bytes
+options of pprof control how the information is presented.
+
 The following flags are recognized by the 'go test' command and
 control the execution of any test:
 
@@ -118,8 +123,8 @@ control the execution of any test:
 	    Write a CPU profile to the specified file before exiting.
 
 	-memprofile mem.out
-	    Write a memory profile to the specified file when all tests
-	    are complete.
+	    Write a memory profile to the specified file after all tests
+	    have passed.
 
 	-memprofilerate n
 	    Enable more precise (and expensive) memory profiles by setting