From 4dd2f490e1c604d014208bf07b21c1aaa72401c0 Mon Sep 17 00:00:00 2001 From: jaffee Date: Thu, 19 Jan 2017 16:54:36 -0600 Subject: [PATCH] add docs about Benchmark Name field --- bench/bench.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/bench/bench.go b/bench/bench.go index 73cc625a8..000909bde 100644 --- a/bench/bench.go +++ b/bench/bench.go @@ -13,7 +13,9 @@ type Benchmark interface { // it is being run simultaneously on multiple "agents". E.G. the agentNum // might be used to make a random seed different for each agent, or have // each agent set a different set of bits. Init's doc string should document - // how the agentNum affects it. + // how the agentNum affects it. Every benchmark should have a 'Name' field + // set by init, which appears when the benchmark is marshalled to json as + // "name". Init(hosts []string, agentNum int) error // Run runs the benchmark. The return value of Run is kept generic so that