Tests: implement REUSE with SPDX identifiers

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

diff --git a/tests/benchmark/README.md b/tests/benchmark/README.md
new file mode 100644 (file)
index 0000000..50c2ba4
--- /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`.