X-Git-Url: https://git.lttng.org/?p=lttng-ust.git;a=blobdiff_plain;f=tests%2Fbenchmark%2FREADME.md;fp=tests%2Fbenchmark%2FREADME.md;h=50c2ba4523892afd9e4fb00d409965146681d4b0;hp=0000000000000000000000000000000000000000;hb=89a8858dc6fdaf6c094d9038db79fbc61469ccef;hpb=53f7d0d7404de911dd62dff06f08539e33ea7519

diff --git a/tests/benchmark/README.md b/tests/benchmark/README.md
new file mode 100644
index 00000000..50c2ba45
--- /dev/null
+++ b/tests/benchmark/README.md
@@ -0,0 +1,17 @@
+<!--
+SPDX-FileCopyrightText: 2013 Zifei Tong <soariez@gmail.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+To run the benchmark:
+
+    ./test_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
+
+`NR_CPUS` can also be configured, but by default is based on the contents of
+`/proc/cpuinfo`.