code review 6553068: testing: document -test.bench flag

testing: document -test.bench flag

Fixes issue 4080.

[francesc, 2012-09-24 18:37:03]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://campoy%40golang.org@code.google.com/p/go/

[rsc, 2012-09-24 18:47:34]

You can edit your $GOROOT/.hg/hgrc and remove the campoy%40golang.org@ from the
URL if you like.

[rsc, 2012-09-24 18:48:21]

http://codereview.appspot.com/6553068/diff/5001/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

http://codereview.appspot.com/6553068/diff/5001/src/pkg/testing/testing.go#ne...
src/pkg/testing/testing.go:18: // For a description of the testing flags, read
I think we usually say "see" instead of "read". Don't indent the next line. That
will put it in a <pre> block, which is unnecessary. Godoc will autolink it even
in text mode.

[francesc, 2012-09-24 18:48:52]

On 2012/09/24 18:47:34, rsc wrote:
> You can edit your $GOROOT/.hg/hgrc and remove the campoy%40golang.org@ from
the
> URL if you like.

Indeed, that's ugly :-)

[francesc, 2012-09-24 18:51:43]

Hello rsc@golang.org (cc: golang-dev@googlegroups.com),

Please take another look.

[francesc, 2012-09-24 18:51:54]

http://codereview.appspot.com/6553068/diff/5001/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

http://codereview.appspot.com/6553068/diff/5001/src/pkg/testing/testing.go#ne...
src/pkg/testing/testing.go:18: // For a description of the testing flags, read
On 2012/09/24 18:48:21, rsc wrote:
> I think we usually say "see" instead of "read". Don't indent the next line.
That
> will put it in a <pre> block, which is unnecessary. Godoc will autolink it
even
> in text mode.

I indented it to avoid putting a dot at the end of the line, which would mess
with the URL id (I think).

[rsc, 2012-09-24 18:59:55]

http://codereview.appspot.com/6553068/diff/7002/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

http://codereview.appspot.com/6553068/diff/7002/src/pkg/testing/testing.go#ne...
src/pkg/testing/testing.go:19: //
http://golang.org/cmd/go/#Description_of_testing_flags
Put a period at the end of the sentence please. Try it in godoc -http=:9999 and
see. It will work fine.

[rsc, 2012-09-24 19:01:20]

Please change CL description to exactly:

testing: document -test.bench flag

Fixes issue 4080.

The first line should be a short summary beginning with the package name (hg log
for examples). The Fixes issue line is a directive to the version control system
to close the issue when this CL is submitted, and it should be spelled as above.
Thanks.

[francesc, 2012-09-24 19:22:34]

Hello rsc@golang.org (cc: golang-dev@googlegroups.com),

Please take another look.

[rsc, 2012-09-24 19:23:51]

LGTM

[adg, 2012-09-24 19:29:02]

NOT LGTM

http://codereview.appspot.com/6553068/diff/3003/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

http://codereview.appspot.com/6553068/diff/3003/src/pkg/testing/testing.go#ne...
src/pkg/testing/testing.go:19: //
http://golang.org/cmd/go/#Description_of_testing_flags.
NOT LGTM

The period here messes up the link. Remove it.

[rsc, 2012-09-24 19:34:36]

>
> The period here messes up the link. Remove it.
>

NO. Fix whatever can't read it.

[rsc, 2012-09-24 19:35:32]

On Mon, Sep 24, 2012 at 3:34 PM, Russ Cox <rsc@golang.org> wrote:
>> The period here messes up the link. Remove it.
>
> NO. Fix whatever can't read it.

Also I don't know what you think can't read it. godoc definitely does
the right thing, as did gmail.

[francesc, 2012-09-24 19:41:37]

http://codereview.appspot.com/6553068/diff/3003/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

http://codereview.appspot.com/6553068/diff/3003/src/pkg/testing/testing.go#ne...
src/pkg/testing/testing.go:19: //
http://golang.org/cmd/go/#Description_of_testing_flags.
On 2012/09/24 19:29:03, adg wrote:
> NOT LGTM
> 
> The period here messes up the link. Remove it.

It doesn't mess anything up. Godoc is a very well written tool ... :-)

I tried it running it on local server mode, and it works.

[adg, 2012-09-24 20:05:40]

LGTM

I should have more faith in our tools.

[francesc, 2012-09-24 20:06:12]

*** Submitted as http://code.google.com/p/go/source/detail?r=6bd5a4ff05ea ***

testing: document -test.bench flag

Fixes issue 4080.

R=rsc, adg
CC=golang-dev
http://codereview.appspot.com/6553068