From 2940c186c992dd7036c824550da643400e82d287 Mon Sep 17 00:00:00 2001 From: Marcelo Juchem Date: Thu, 25 Oct 2012 19:00:59 -0700 Subject: [PATCH] fix Benchmark docs Summary: fix Benchmark docs Test Plan: read Reviewed By: andrei.alexandrescu@fb.com FB internal diff: D611820 --- folly/docs/Benchmark.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/folly/docs/Benchmark.md b/folly/docs/Benchmark.md index 635a261d..2273a783 100644 --- a/folly/docs/Benchmark.md +++ b/folly/docs/Benchmark.md @@ -184,12 +184,12 @@ measurements in any way. Sometimes benchmarking code must to some preparation work that is physically inside the benchmark function, but should not take part to its time budget. To temporarily suspend the benchmark, use the -pseudo-statement `SUSPEND_BENCHMARK` as follows: +pseudo-statement `BENCHMARK_SUSPEND` as follows: ``` Cpp BENCHMARK(insertBackVector, n) { vector v; - SUSPEND_BENCHMARK { + BENCHMARK_SUSPEND { v.reserve(n); } FOR_EACH_RANGE (i, 0, n) { @@ -201,11 +201,11 @@ pseudo-statement `SUSPEND_BENCHMARK` as follows: The preallocation effected with `v.reserve(n)` will not count toward the total run time of the benchmark. -Only the main thread should call `SUSPEND_BENCHMARK` (and of course it +Only the main thread should call `BENCHMARK_SUSPEND` (and of course it should not call it while other threads are doing actual work). This is because the timer is application-global. -If the scope introduced by `SUSPEND_BENCHMARK` is not desired, you may +If the scope introduced by `BENCHMARK_SUSPEND` is not desired, you may want to "manually" use the `BenchmarkSuspender` type. Constructing such an object suspends time measurement, and destroying it resumes the measurement. If you want to resume time measurement before the -- 2.34.1