diff options
| author | Andrew Gerrand <adg@golang.org> | 2013-05-13 09:35:18 -0700 |
|---|---|---|
| committer | Andrew Gerrand <adg@golang.org> | 2013-05-13 09:35:18 -0700 |
| commit | 6c7631126f0cad808dd4cc7c3c02ac9c2ff6e6c0 (patch) | |
| tree | f934a5115a352cee8dc71e9ca416f0395d592940 | |
| parent | 9294a08f1b2a8470fdb52504caf06a532a678b09 (diff) | |
| download | go-6c7631126f0cad808dd4cc7c3c02ac9c2ff6e6c0.tar.gz go-6c7631126f0cad808dd4cc7c3c02ac9c2ff6e6c0.zip | |
[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 #5444.
R=golang-dev, minux.ma, adg, r
CC=golang-dev
https://golang.org/cl/9144050
»»»
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/9387043
| -rw-r--r-- | src/pkg/runtime/race/doc.go | 9 | ||||
| -rw-r--r-- | src/pkg/runtime/race/race.go | 1 |
2 files changed, 9 insertions, 1 deletions
diff --git a/src/pkg/runtime/race/doc.go b/src/pkg/runtime/race/doc.go new file mode 100644 index 0000000000..aef805dad7 --- /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 +package race diff --git a/src/pkg/runtime/race/race.go b/src/pkg/runtime/race/race.go index b0a5c9a502..ee13057e36 100644 --- 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 /* |