Skip to content

Commit a5c80f1

Browse files
committed
Document benchmark recipes
1 parent f76d78e commit a5c80f1

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

tools/make/lib/benchmark/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,39 @@ This directory contains [`make`][make] recipes for running language benchmarks.
2222
Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
2323
```
2424

25+
### Commands
26+
27+
#### benchmark
28+
29+
Runs benchmarks.
30+
31+
<!-- run-disable -->
32+
33+
```bash
34+
$ make benchmark
35+
```
36+
37+
The recipe recognizes the following environment variables:
38+
39+
- **BENCHMARKS_FILTER**: filepath pattern; e.g., `.*/blas/base/dasum/.*`.
40+
41+
This recipe is an **alias** for `benchmark-javascript`, which is documented below.
42+
43+
44+
#### benchmark-lang
45+
46+
Runs cross-language benchmarks.
47+
48+
<!-- run-disable -->
49+
50+
```bash
51+
$ make benchmark-lang
52+
```
53+
54+
The recipe recognizes the environment variables for each language-specific recipe documented below.
55+
56+
This recipe is useful when wanting to glob for benchmark files, irrespective of language, for a particular package in order to compare cross-language performance.
57+
2558
* * *
2659

2760
### C

0 commit comments

Comments
 (0)