From b3b4d975f4e80054249980530cb2a3f7a9c24294 Mon Sep 17 00:00:00 2001 From: "Jeff R. Allen" Date: Fri, 27 Oct 2017 15:59:19 +0200 Subject: [PATCH] benchmarks: document required Linux packages To get the perf tool to work on Linux, you need to install some packages. Document them in the README. Change-Id: I00333d94e1eb8fccddf4cdcdd69cb3156b71f40b Reviewed-on: https://go-review.googlesource.com/73878 Reviewed-by: Ian Lance Taylor --- README | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README b/README index 3b25c1b..16fd832 100644 --- a/README +++ b/README @@ -21,6 +21,11 @@ This format can be processed by tools like benchstat (https://golang.org/x/perf/cmd/benchstat) and benchplot (https://godoc.org/github.com/aclements/go-misc/benchplot). +Required extra tools: + For Linux, you need "perf". On Debian/Ubuntu, you can install + package "perf-tools-common" to get it. Run "perf" once with no + arguments to check if it requires additional packages to be installed. + To submit changes to this repository, see http://golang.org/doc/contribute.html. [1] https://github.com/golang/proposal/blob/master/design/14313-benchmark-format.md