]> Cypherpunks repositories - gostls13.git/commitdiff
doc: recommend benchstat for performance commits
authorRhys Hiltner <rhys@justin.tv>
Fri, 31 Aug 2018 03:09:08 +0000 (20:09 -0700)
committerBrad Fitzpatrick <bradfitz@golang.org>
Fri, 31 Aug 2018 03:52:31 +0000 (03:52 +0000)
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 <bradfitz@golang.org>
doc/contribute.html

index 5d8e1163a04075f6940094e6df95a43d363b12a1..2068ab8a3e3438eca8e135811c22da027987226c 100644 (file)
@@ -696,7 +696,7 @@ Don't use HTML, Markdown, or any other markup language.
 <p>
 Add any relevant information, such as benchmark data if the change
 affects performance.
-The <a href="https://godoc.org/golang.org/x/tools/cmd/benchcmp">benchcmp</a>
+The <a href="https://godoc.org/golang.org/x/perf/cmd/benchstat">benchstat</a>
 tool is conventionally used to format
 benchmark data for change descriptions.
 </p>