code review 9387043: [release-branch.go1.1] runtime/race: improve public doc...

[release-branch.go1.1] runtime/race: improve public documentation

««« CL 9144050 / d29da2ced72b
runtime/race: improve public documentation
Move the documentation from race.go to doc.go, because
race.go uses +build race, so it's not normally parsed by go doc.
Rephrase the documentation for end users, provide link to race
detector manual.
Fixes issue 5444.

R=golang-dev, minux.ma, adg, r
CC=golang-dev
https://codereview.appspot.com/9144050
»»»

[adg, 2013-05-13 16:25:02]

Hello golang-dev@googlegroups.com,

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

[bradfitz, 2013-05-13 16:31:04]

LGTM
On May 13, 2013 9:25 AM, <adg@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:
> [release-branch.go1.1] runtime/race: improve public documentation
>
> ««« CL 9144050 / d29da2ced72b
> runtime/race: improve public documentation
> Move the documentation from race.go to doc.go, because
> race.go uses +build race, so it's not normally parsed by go doc.
> Rephrase the documentation for end users, provide link to race
> detector manual.
> Fixes issue 5444.
>
> R=golang-dev, minux.ma, adg, r
> CC=golang-dev
>
https://codereview.appspot.**com/9144050<https://codereview.appspot.com/9144050>
> »»»
>
>
> Please review this at
https://codereview.appspot.**com/9387043/<https://codereview.appspot.com/9387...
>
> Affected files:
>   A src/pkg/runtime/race/doc.go
>   M src/pkg/runtime/race/race.go
>
>
> Index: src/pkg/runtime/race/doc.go
> ==============================**==============================**=======
> new file mode 100644
> --- /dev/null
> +++ b/src/pkg/runtime/race/doc.go
> @@ -0,0 +1,9 @@
> +// Copyright 2013 The Go Authors. All rights reserved.
> +// Use of this source code is governed by a BSD-style
> +// license that can be found in the LICENSE file.
> +
> +// Package race implements data race detection logic.
> +// No public interface is provided.
> +// For details about the race detector see
> +//
http://golang.org/doc/**articles/race_detector.html<http://golang.org/doc/art...
> +package race
> Index: src/pkg/runtime/race/race.go
> ==============================**==============================**=======
> --- a/src/pkg/runtime/race/race.go
> +++ b/src/pkg/runtime/race/race.go
> @@ -4,7 +4,6 @@
>
>  // +build race,linux,amd64 race,darwin,amd64 race,windows,amd64
>
> -// Package race provides low-level facilities for data race detection.
>  package race
>
>  /*
>
>
> --
>
> ---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...
> .
>
>
>

[adg, 2013-05-13 16:35:25]

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

[release-branch.go1.1] runtime/race: improve public documentation

««« CL 9144050 / d29da2ced72b
runtime/race: improve public documentation
Move the documentation from race.go to doc.go, because
race.go uses +build race, so it's not normally parsed by go doc.
Rephrase the documentation for end users, provide link to race
detector manual.
Fixes issue 5444.

R=golang-dev, minux.ma, adg, r
CC=golang-dev
https://codereview.appspot.com/9144050
»»»

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