code review 7657045: cmd/go: better documentation about profiling

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

Fixes issue 4990.

[r, 2013-03-13 20:45:55]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://code.google.com/p/go

[bradfitz, 2013-03-13 20:50:08]

LGTM

On Wed, Mar 13, 2013 at 1:45 PM, <r@golang.org> wrote:

> Reviewers: golang-dev1,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://code.google.com/p/go
>
>
> Description:
> cmd/go: better documentation about profiling
> Point the user to "go tool pprof" and mention some
> important flags.
>
> Fixes issue 4990.
>
> Please review this at
https://codereview.appspot.**com/7657045/<https://codereview.appspot.com/7657...
>
> Affected files:
>   M src/cmd/go/doc.go
>   M src/cmd/go/test.go
>
>
> Index: src/cmd/go/doc.go
> ==============================**==============================**=======
> --- a/src/cmd/go/doc.go
> +++ b/src/cmd/go/doc.go
> @@ -685,6 +685,11 @@
>  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 @@
>             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
> Index: src/cmd/go/test.go
> ==============================**==============================**=======
> --- a/src/cmd/go/test.go
> +++ b/src/cmd/go/test.go
> @@ -81,6 +81,11 @@
>  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 @@
>             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
>
>
> --
>
> ---You received this message because you are subscribed to the Google
> Groups "golang-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to
golang-dev+unsubscribe@**googlegroups.com<golang-dev%2Bunsubscribe@googlegrou...
> .
> For more options, visit
https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/o...
> .
>
>
>

[r, 2013-03-13 20:56:54]

*** Submitted as https://code.google.com/p/go/source/detail?r=149360268947 ***

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

Fixes issue 4990.

R=golang-dev, bradfitz
CC=golang-dev
https://codereview.appspot.com/7657045