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

x/benchmarks: no documentation #9131

Closed
rsc opened this issue Nov 19, 2014 · 2 comments
Closed

x/benchmarks: no documentation #9131

rsc opened this issue Nov 19, 2014 · 2 comments

Comments

@rsc
Copy link
Contributor

rsc commented Nov 19, 2014

There is absolutely no documentation about how to run the benchmarks.
If you check out the golang.org/x/benchmarks repo, the README says basically
"This is an empty repo. When you clone it to make a new repo, be sure to edit this
file to describe the new repo".

If you poke around and find out that the bench program is the one package main
and then build and run it, you get cryptic output and no idea how to move forward:

% ./bench
build,garbage,json,http
%

godoc bench
or
http://godoc.org/golang.org/x/benchmarks/bench
have NOTHING.

This needs to be documented well. It is not documented at all right now.
@bradfitz bradfitz modified the milestone: Go1.5 Dec 16, 2014
@mikioh mikioh changed the title x/benchmarks: no documentation bench: no documentation Jan 5, 2015
@rsc rsc removed accepted labels Apr 14, 2015
@rsc rsc changed the title bench: no documentation x/bench: no documentation Apr 14, 2015
@rsc rsc changed the title x/bench: no documentation x/benchmarks: no documentation Apr 14, 2015
@rsc rsc modified the milestones: Unreleased, Go1.5 Apr 14, 2015
@andrewaustin
Copy link

This seems like it should be closed. See:
https://github.com/golang/benchmarks
https://godoc.org/golang.org/x/benchmarks/bench
https://github.com/golang/go/wiki/PerfDashboard

(Although, maybe the metric descriptions should be moved from the wiki into godoc or at least the readme?)

@ianlancetaylor
Copy link
Contributor

I'm inclined to agree, but leaving for @rsc since he opened it.

@rsc rsc closed this as completed Dec 3, 2015
@golang golang locked and limited conversation to collaborators Dec 14, 2016
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

6 participants