Skip to content

Commit 677c4ac

Browse files
rhyshbradfitz
authored andcommitted
doc: recommend benchstat for performance commits
The benchstat tool computes statistics about benchmarks, including whether any differences are statistically significant. Recommend its use in commit messages of performance-related changes rather than the simpler benchcmp tool. Change-Id: I4b35c2d892b48e60c3064489b035774792c19c30 Reviewed-on: https://go-review.googlesource.com/132515 Reviewed-by: Brad Fitzpatrick <[email protected]>
1 parent 7c96f9b commit 677c4ac

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/contribute.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ <h3>Main content</h3>
696696
<p>
697697
Add any relevant information, such as benchmark data if the change
698698
affects performance.
699-
The <a href="https://godoc.org/golang.org/x/tools/cmd/benchcmp">benchcmp</a>
699+
The <a href="https://godoc.org/golang.org/x/perf/cmd/benchstat">benchstat</a>
700700
tool is conventionally used to format
701701
benchmark data for change descriptions.
702702
</p>

0 commit comments

Comments
 (0)