Document Fortran benchmark recipes

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