From 677c4acc98fe22a8be14148f61c0c637a34c01d9 Mon Sep 17 00:00:00 2001 From: Rhys Hiltner Date: Thu, 30 Aug 2018 20:09:08 -0700 Subject: [PATCH] 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 --- doc/contribute.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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.

Add any relevant information, such as benchmark data if the change affects performance. -The benchcmp +The benchstat tool is conventionally used to format benchmark data for change descriptions.

-- 2.50.0