[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

diff --git a/src/pkg/runtime/race/doc.go b/src/pkg/runtime/race/doc.go
new file mode 100644 (file)
index 0000000..aef805d
--- /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 b0a5c9a5029161d59c647d5b7765ce520976f12e..ee13057e36a3abc3fb22d761825d47e09015a2c3 100644 (file)
--- 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
 
 /*