tests: benchmark: improve benchmark scalability accuracy

[lttng-ust.git] / tests / benchmark / README

diff --git a/tests/benchmark/README b/tests/benchmark/README
index 8a9321d1f46ae8bd49d7974ff1119f0ec7116dd0..3294f10a83f7174c16533b9402b6228a6834631a 100644 (file)
--- a/tests/benchmark/README
+++ b/tests/benchmark/README
@@ -1,9 +1,11 @@
-UST Benchmark
+To run the benchmark:
 
-INSTALLATION INSTRUCTIONS:
+    ./test_benchmark
 
-  - run ./install  to install and compile UST/benchmark
-  - run ./run  to perform the benchmark
+You can specify the number of iterations, events and threads by setting
+environment variables ITERS, DURATION, NR_THREADS respectively:
 
+    ITERS=10 DURATION=20 NR_THREADS=4 ./test_benchmark
 
-The trace files will be automatically saved at $HOME/.usttraces
+NR_CPUS can also be configured, but by default is based on the contents of
+/proc/cpuinfo.