From: Rhys Hiltner <rhys@justin.tv>
Date: Fri, 31 Aug 2018 03:09:08 +0000 (-0700)
Subject: doc: recommend benchstat for performance commits
X-Git-Tag: go1.12beta1~1198
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=677c4acc98fe22a8be14148f61c0c637a34c01d9;p=gostls13.git

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 <bradfitz@golang.org>
---

diff --git a/doc/contribute.html b/doc/contribute.html
index 5d8e1163a0..2068ab8a3e 100644
--- a/doc/contribute.html
+++ b/doc/contribute.html
@@ -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>