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.

Sign up for GitHub

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

Jump to bottom

x/perf/benchstat: README.md is out of date #20727

Closed
ALTree opened this issue Jun 19, 2017 · 1 comment
Closed

x/perf/benchstat: README.md is out of date #20727

ALTree opened this issue Jun 19, 2017 · 1 comment
Labels
Documentation FrozenDueToAge
Milestone
Unreleased

Comments

@ALTree
Copy link
Member

ALTree commented Jun 19, 2017

benchstat readme, which is also shown on godoc, is out of date. It starts like this

Usage:
benchstat [-delta-test name] [-geomean] [-html] old.txt [new.txt] [more.txt ...]

while benchstat -h says:

usage: benchstat [options] old.txt [new.txt] [more.txt ...]
options:
  -alpha α
    	consider change significant if p < α (default 0.05)
  -delta-test test
    	significance test to apply to delta: utest, ttest, or none (default "utest")
  -geomean
    	print the geometric mean of each file
  -html
    	print results as an HTML table
  -split labels
    	split benchmarks by labels (default "pkg,goos,goarch")

note that the whole readme does not even mention the -alpha significance flag.
@gopherbot gopherbot added this to the Unreleased milestone Jun 19, 2017
@ALTree ALTree mentioned this issue Dec 15, 2017
Closed
@gopherbot
Copy link

Change https://golang.org/cl/84483 mentions this issue: benchstat: update readme

@golang golang locked and limited conversation to collaborators Jan 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
2 participants
@ALTree @gopherbot