From d647fc2532668b2b75a92f468487b8085e6ed58b Mon Sep 17 00:00:00 2001 From: Jiayu Yi Date: Fri, 18 Sep 2020 15:35:04 +0000 Subject: [PATCH] cmd/benchcmp: mention deprecation in docs A deprecation notice was added to benchcmp in https://github.com/golang/tools/commit/a1f8cf00470bdcdcccb2aa1be10335441650c33e, but there is no mention of it in the benchcmp docs at https://pkg.go.dev/golang.org/x/tools/cmd/benchcmp, so it may not be immediately obvious to new users. This PR adds the deprecation notice to the documentation as well to make it easier to discover. Change-Id: Ib49228abc140435023694173511caa4d3c6c0672 GitHub-Last-Rev: 8e19863394defcf46483fe5f6377652e21ddf9d0 GitHub-Pull-Request: golang/tools#252 Reviewed-on: https://go-review.googlesource.com/c/tools/+/255878 Reviewed-by: Keith Randall Trust: Giovanni Bajo --- cmd/benchcmp/doc.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cmd/benchcmp/doc.go b/cmd/benchcmp/doc.go index f5c7a3619f..cfe9801d8b 100644 --- a/cmd/benchcmp/doc.go +++ b/cmd/benchcmp/doc.go @@ -4,6 +4,8 @@ /* +Deprecated: benchcmp is deprecated in favor of benchstat: golang.org/x/perf/cmd/benchstat + The benchcmp command displays performance changes between benchmarks. Benchcmp parses the output of two 'go test' benchmark runs,