You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tools/make/lib/benchmark/README.md
+37-37Lines changed: 37 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Benchmark
2
2
3
-
> Benchmark recipes.
3
+
> Benchmark commands.
4
4
5
5
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
6
6
7
7
<sectionclass="intro">
8
8
9
-
This directory contains [`make`][make]recipes for running language benchmarks.
9
+
This directory contains [`make`][make]rules for running language benchmarks.
10
10
11
11
</section>
12
12
@@ -34,11 +34,11 @@ Runs benchmarks.
34
34
$ make benchmark
35
35
```
36
36
37
-
The recipe supports the following environment variables:
37
+
The command supports the following environment variables:
The recipe supports the environment variables supported by each language-specific (`benchmark-<lang>`) recipe documented below.
54
+
The command supports the environment variables supported by each language-specific (`benchmark-<lang>`) command documented below.
55
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.
56
+
This command is useful when wanting to glob for benchmark files, irrespective of language, for a particular package in order to compare cross-language performance.
57
57
58
58
* * *
59
59
60
60
### C
61
61
62
-
> **Note**: C benchmark recipes delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
62
+
> **Note**: C benchmark commands delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
63
63
64
64
#### benchmark-c
65
65
@@ -71,14 +71,14 @@ Runs C benchmarks.
71
71
$ make benchmark-c
72
72
```
73
73
74
-
The recipe supports the following environment variables:
74
+
The command supports the following environment variables:
This recipe is useful when wanting to glob for C benchmark files (e.g., run all C benchmarks for a particular package).
81
+
This command is useful when wanting to glob for C benchmark files (e.g., run all C benchmarks for a particular package).
82
82
83
83
#### benchmark-c-files
84
84
@@ -90,20 +90,20 @@ Runs a specified list of C benchmark files.
90
90
$ make benchmark-c-files FILES='/foo/benchmark.c /bar/benchmark.c'
91
91
```
92
92
93
-
The recipe supports the following environment variables:
93
+
The command supports the following environment variables:
94
94
95
95
-**FILES**: list of C benchmark files.
96
96
-**BLAS**: BLAS library name; e.g., `openblas`.
97
97
-**BLAS_DIR**: BLAS directory.
98
98
-**C_COMPILER**: C compiler; e.g., `gcc`.
99
99
100
-
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`).
100
+
This command 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`).
101
101
102
102
* * *
103
103
104
104
### C++
105
105
106
-
> **Note**: C++ benchmark recipes delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
106
+
> **Note**: C++ benchmark commands delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
107
107
108
108
#### benchmark-cpp
109
109
@@ -115,12 +115,12 @@ Runs C++ benchmarks.
115
115
$ make benchmark-cpp
116
116
```
117
117
118
-
The recipe supports the following environment variables:
118
+
The command supports the following environment variables:
This recipe is useful when wanting to glob for C++ benchmark files (e.g., run all C++ benchmarks for a particular package).
123
+
This command is useful when wanting to glob for C++ benchmark files (e.g., run all C++ benchmarks for a particular package).
124
124
125
125
#### benchmark-cpp-files
126
126
@@ -132,18 +132,18 @@ Runs a specified list of C++ benchmark files.
132
132
$ make benchmark-cpp-files FILES='/foo/benchmark.cpp /bar/benchmark.cpp'
133
133
```
134
134
135
-
The recipe supports the following environment variables:
135
+
The command supports the following environment variables:
136
136
137
137
-**FILES**: list of C++ benchmark files.
138
138
-**CXX_COMPILER**: C++ compiler; e.g., `g++`.
139
139
140
-
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`).
140
+
This command 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`).
141
141
142
142
* * *
143
143
144
144
### Fortran
145
145
146
-
> **Note**: Fortran benchmark recipes delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
146
+
> **Note**: Fortran benchmark commands delegate to local Makefiles which are responsible for actually compiling and running the respective benchmarks.
147
147
148
148
#### benchmark-fortran
149
149
@@ -155,12 +155,12 @@ Runs Fortran benchmarks.
155
155
$ make benchmark-fortran
156
156
```
157
157
158
-
The recipe supports the following environment variables:
158
+
The command supports the following environment variables:
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`).
180
+
This command 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`).
181
181
182
182
* * *
183
183
@@ -193,11 +193,11 @@ Runs JavaScript benchmarks.
193
193
$ make benchmark-javascript
194
194
```
195
195
196
-
The recipe supports the following environment variables:
196
+
The command supports the following environment variables:
This recipe is useful when wanting to glob for JavaScript benchmark files (e.g., run all JavaScript benchmarks for a particular package).
200
+
This command is useful when wanting to glob for JavaScript benchmark files (e.g., run all JavaScript benchmarks for a particular package).
201
201
202
202
#### benchmark-javascript-files
203
203
@@ -209,11 +209,11 @@ Runs a specified list of JavaScript benchmark files.
209
209
$ make benchmark-javascript-files FILES='/foo/benchmark.js /bar/benchmark.js'
210
210
```
211
211
212
-
The recipe supports the following environment variables:
212
+
The command supports the following environment variables:
213
213
214
214
-**FILES**: list of JavaScript benchmark files.
215
215
216
-
This recipe is useful when wanting to run a list of JavaScript benchmark files generated by some other command (e.g., a filtered list of changed JavaScript benchmark files obtained via `git diff`).
216
+
This command is useful when wanting to run a list of JavaScript benchmark files generated by some other command (e.g., a filtered list of changed JavaScript benchmark files obtained via `git diff`).
217
217
218
218
* * *
219
219
@@ -229,11 +229,11 @@ Runs Julia benchmarks.
229
229
$ make benchmark-julia
230
230
```
231
231
232
-
The recipe supports the following environment variables:
232
+
The command supports the following environment variables:
This recipe is useful when wanting to glob for Julia benchmark files (e.g., run all Julia benchmarks for a particular package).
236
+
This command is useful when wanting to glob for Julia benchmark files (e.g., run all Julia benchmarks for a particular package).
237
237
238
238
#### benchmark-julia-files
239
239
@@ -245,11 +245,11 @@ Runs a specified list of Julia benchmark files.
245
245
$ make benchmark-julia-files FILES='/foo/benchmark.jl /bar/benchmark.jl'
246
246
```
247
247
248
-
The recipe supports the following environment variables:
248
+
The command supports the following environment variables:
249
249
250
250
-**FILES**: list of Julia benchmark files.
251
251
252
-
This recipe is useful when wanting to run a list of Julia benchmark files generated by some other command (e.g., a filtered list of changed Julia benchmark files obtained via `git diff`).
252
+
This command is useful when wanting to run a list of Julia benchmark files generated by some other command (e.g., a filtered list of changed Julia benchmark files obtained via `git diff`).
253
253
254
254
* * *
255
255
@@ -265,11 +265,11 @@ Runs Python benchmarks.
265
265
$ make benchmark-python
266
266
```
267
267
268
-
The recipe supports the following environment variables:
268
+
The command supports the following environment variables:
This recipe is useful when wanting to glob for Python benchmark files (e.g., run all Python benchmarks for a particular package).
272
+
This command is useful when wanting to glob for Python benchmark files (e.g., run all Python benchmarks for a particular package).
273
273
274
274
#### benchmark-python-files
275
275
@@ -281,11 +281,11 @@ Runs a specified list of Python benchmark files.
281
281
$ make benchmark-python-files FILES='/foo/benchmark.py /bar/benchmark.py'
282
282
```
283
283
284
-
The recipe supports the following environment variables:
284
+
The command supports the following environment variables:
285
285
286
286
-**FILES**: list of Python benchmark files.
287
287
288
-
This recipe is useful when wanting to run a list of Python benchmark files generated by some other command (e.g., a filtered list of changed Python benchmark files obtained via `git diff`).
288
+
This command is useful when wanting to run a list of Python benchmark files generated by some other command (e.g., a filtered list of changed Python benchmark files obtained via `git diff`).
289
289
290
290
* * *
291
291
@@ -301,11 +301,11 @@ Runs R benchmarks.
301
301
$ make benchmark-r
302
302
```
303
303
304
-
The recipe supports the following environment variables:
304
+
The command supports the following environment variables:
This recipe is useful when wanting to glob for R benchmark files (e.g., run all R benchmarks for a particular package).
308
+
This command is useful when wanting to glob for R benchmark files (e.g., run all R benchmarks for a particular package).
309
309
310
310
#### benchmark-r-files
311
311
@@ -317,11 +317,11 @@ Runs a specified list of R benchmark files.
317
317
$ make benchmark-r-files FILES='/foo/benchmark.R /bar/benchmark.R'
318
318
```
319
319
320
-
The recipe supports the following environment variables:
320
+
The command supports the following environment variables:
321
321
322
322
-**FILES**: list of R benchmark files.
323
323
324
-
This recipe is useful when wanting to run a list of R benchmark files generated by some other command (e.g., a filtered list of changed R benchmark files obtained via `git diff`).
324
+
This command is useful when wanting to run a list of R benchmark files generated by some other command (e.g., a filtered list of changed R benchmark files obtained via `git diff`).
0 commit comments