Document C++ benchmark recipes

kgryte · kgryte · commit 3303cf2c1efe · 2018-01-10T17:11:35.000-08:00
diff --git a/tools/make/lib/benchmark/README.md b/tools/make/lib/benchmark/README.md
@@ -68,6 +68,46 @@ This recipe is useful when wanting to run a list of C benchmark files generated
 
 * * *
 
+### C++
+
+**Note**: C++ benchmark recipes delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
+
+#### benchmark-cpp
+
+Runs C++ benchmarks.
+
+<!-- run-disable -->
+
+```bash
+$ make benchmark-cpp
+```
+
+The recipe recognizes the following environment variables:
+
+-   **BENCHMARKS_FILTER**: filepath pattern; e.g., `.*/blas/base/dasum/.*`.
+-   **CXX_COMPILER**: C++ compiler; e.g., `g++`.
+
+This recipe is useful when wanting to glob for C++ benchmark files (e.g., run all C++ benchmarks for a particular package).
+
+#### benchmark-cpp-files
+
+Runs a specified list of C++ benchmark files.
+
+<!-- run-disable -->
+
+```bash
+$ make benchmark-cpp-files FILES='/foo/benchmark.cpp /bar/benchmark.cpp'
+```
+
+The recipe recognizes the following environment variables:
+
+-   **FILES**: list of C++ benchmark files.
+-   **CXX_COMPILER**: C++ compiler; e.g., `g++`.
+
+This recipe is useful when wanting to run a list of C++ benchmark files generated by some other command (e.g., a filtered list of changed C++ benchmark files obtained via `git diff`).
+
+* * *
+
 </section>
 
 <!-- /.usage -->
