Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

runtime/race: confusing public documentation #5444

Closed
dvyukov opened this issue May 12, 2013 · 3 comments
Closed

runtime/race: confusing public documentation #5444

dvyukov opened this issue May 12, 2013 · 3 comments

Comments

@dvyukov
Copy link
Member

dvyukov commented May 12, 2013

http://tip.golang.org/pkg/runtime/race/
contains:
"
Command race

Package race provides low-level facilities for data race detection.

This program is used to verify the race detector by running the tests and parsing their
output. It does not check stack correctness, completeness or anything else: it merely
verifies that if a test is expected to be racy then the race is detected.
"

This is package rather than a command, and the comment for the test driver should not be
visible here.
@dvyukov
Copy link
Member Author

dvyukov commented May 12, 2013

Comment 1:

sent https://golang.org/cl/9144050

Labels changed: added racedetector.

Owner changed to @dvyukov.

Status changed to Started.

@dvyukov
Copy link
Member Author

dvyukov commented May 13, 2013

Comment 2:

This issue was closed by revision 5a7e14c.

Status changed to Fixed.

@adg
Copy link
Contributor

adg commented May 13, 2013

Comment 3:

This issue was closed by revision a3df1aafb2f6.

adg added a commit that referenced this issue May 11, 2015
««« 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
@golang golang locked and limited conversation to collaborators Jun 24, 2016
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants