Skip to content

Commit 27f68f2

Browse files
committed
Fix use of 'recipe'
1 parent 1999afa commit 27f68f2

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

tools/make/lib/benchmark/README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Benchmark
22

3-
> Benchmark recipes.
3+
> Benchmark commands.
44
55
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
66

77
<section class="intro">
88

9-
This directory contains [`make`][make] recipes for running language benchmarks.
9+
This directory contains [`make`][make] rules for running language benchmarks.
1010

1111
</section>
1212

@@ -34,11 +34,11 @@ Runs benchmarks.
3434
$ make benchmark
3535
```
3636

37-
The recipe supports the following environment variables:
37+
The command supports the following environment variables:
3838

3939
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/dasum/.*`.
4040

41-
This recipe is an **alias** for `benchmark-javascript`, which is documented below.
41+
This command is an **alias** for `benchmark-javascript`, which is documented below.
4242

4343

4444
#### benchmark-lang
@@ -51,15 +51,15 @@ Runs cross-language benchmarks.
5151
$ make benchmark-lang
5252
```
5353

54-
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.
5555

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.
5757

5858
* * *
5959

6060
### C
6161

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.
6363
6464
#### benchmark-c
6565

@@ -71,14 +71,14 @@ Runs C benchmarks.
7171
$ make benchmark-c
7272
```
7373

74-
The recipe supports the following environment variables:
74+
The command supports the following environment variables:
7575

7676
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/abs/.*`.
7777
- **BLAS**: BLAS library name; e.g., `openblas`.
7878
- **BLAS_DIR**: BLAS directory.
7979
- **C_COMPILER**: C compiler; e.g., `gcc`.
8080

81-
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).
8282

8383
#### benchmark-c-files
8484

@@ -90,20 +90,20 @@ Runs a specified list of C benchmark files.
9090
$ make benchmark-c-files FILES='/foo/benchmark.c /bar/benchmark.c'
9191
```
9292

93-
The recipe supports the following environment variables:
93+
The command supports the following environment variables:
9494

9595
- **FILES**: list of C benchmark files.
9696
- **BLAS**: BLAS library name; e.g., `openblas`.
9797
- **BLAS_DIR**: BLAS directory.
9898
- **C_COMPILER**: C compiler; e.g., `gcc`.
9999

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`).
101101

102102
* * *
103103

104104
### C++
105105

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.
107107
108108
#### benchmark-cpp
109109

@@ -115,12 +115,12 @@ Runs C++ benchmarks.
115115
$ make benchmark-cpp
116116
```
117117

118-
The recipe supports the following environment variables:
118+
The command supports the following environment variables:
119119

120120
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/beta/.*`.
121121
- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
122122

123-
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).
124124

125125
#### benchmark-cpp-files
126126

@@ -132,18 +132,18 @@ Runs a specified list of C++ benchmark files.
132132
$ make benchmark-cpp-files FILES='/foo/benchmark.cpp /bar/benchmark.cpp'
133133
```
134134

135-
The recipe supports the following environment variables:
135+
The command supports the following environment variables:
136136

137137
- **FILES**: list of C++ benchmark files.
138138
- **CXX_COMPILER**: C++ compiler; e.g., `g++`.
139139

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`).
141141

142142
* * *
143143

144144
### Fortran
145145

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.
147147
148148
#### benchmark-fortran
149149

@@ -155,12 +155,12 @@ Runs Fortran benchmarks.
155155
$ make benchmark-fortran
156156
```
157157

158-
The recipe supports the following environment variables:
158+
The command supports the following environment variables:
159159

160160
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/blas/base/daxpy/.*`.
161161
- **FORTRAN_COMPILER**: Fortran compiler; e.g., `gfortran`.
162162

163-
This recipe is useful when wanting to glob for Fortran benchmark files (e.g., run all Fortran benchmarks for a particular package).
163+
This command is useful when wanting to glob for Fortran benchmark files (e.g., run all Fortran benchmarks for a particular package).
164164

165165
#### benchmark-fortran-files
166166

@@ -172,12 +172,12 @@ Runs a specified list of Fortran benchmark files.
172172
$ make benchmark-fortran-files FILES='/foo/benchmark.f /bar/benchmark.f'
173173
```
174174

175-
The recipe supports the following environment variables:
175+
The command supports the following environment variables:
176176

177177
- **FILES**: list of Fortran benchmark files.
178178
- **FORTRAN_COMPILER**: Fortran compiler; e.g., `gfortran`.
179179

180-
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`).
181181

182182
* * *
183183

@@ -193,11 +193,11 @@ Runs JavaScript benchmarks.
193193
$ make benchmark-javascript
194194
```
195195

196-
The recipe supports the following environment variables:
196+
The command supports the following environment variables:
197197

198198
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/utils/group-by/.*`.
199199

200-
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).
201201

202202
#### benchmark-javascript-files
203203

@@ -209,11 +209,11 @@ Runs a specified list of JavaScript benchmark files.
209209
$ make benchmark-javascript-files FILES='/foo/benchmark.js /bar/benchmark.js'
210210
```
211211

212-
The recipe supports the following environment variables:
212+
The command supports the following environment variables:
213213

214214
- **FILES**: list of JavaScript benchmark files.
215215

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`).
217217

218218
* * *
219219

@@ -229,11 +229,11 @@ Runs Julia benchmarks.
229229
$ make benchmark-julia
230230
```
231231

232-
The recipe supports the following environment variables:
232+
The command supports the following environment variables:
233233

234234
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/erf/.*`.
235235

236-
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).
237237

238238
#### benchmark-julia-files
239239

@@ -245,11 +245,11 @@ Runs a specified list of Julia benchmark files.
245245
$ make benchmark-julia-files FILES='/foo/benchmark.jl /bar/benchmark.jl'
246246
```
247247

248-
The recipe supports the following environment variables:
248+
The command supports the following environment variables:
249249

250250
- **FILES**: list of Julia benchmark files.
251251

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`).
253253

254254
* * *
255255

@@ -265,11 +265,11 @@ Runs Python benchmarks.
265265
$ make benchmark-python
266266
```
267267

268-
The recipe supports the following environment variables:
268+
The command supports the following environment variables:
269269

270270
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/digamma/.*`.
271271

272-
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).
273273

274274
#### benchmark-python-files
275275

@@ -281,11 +281,11 @@ Runs a specified list of Python benchmark files.
281281
$ make benchmark-python-files FILES='/foo/benchmark.py /bar/benchmark.py'
282282
```
283283

284-
The recipe supports the following environment variables:
284+
The command supports the following environment variables:
285285

286286
- **FILES**: list of Python benchmark files.
287287

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`).
289289

290290
* * *
291291

@@ -301,11 +301,11 @@ Runs R benchmarks.
301301
$ make benchmark-r
302302
```
303303

304-
The recipe supports the following environment variables:
304+
The command supports the following environment variables:
305305

306306
- **BENCHMARKS_FILTER**: file path pattern; e.g., `.*/math/base/special/expm1/.*`.
307307

308-
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).
309309

310310
#### benchmark-r-files
311311

@@ -317,11 +317,11 @@ Runs a specified list of R benchmark files.
317317
$ make benchmark-r-files FILES='/foo/benchmark.R /bar/benchmark.R'
318318
```
319319

320-
The recipe supports the following environment variables:
320+
The command supports the following environment variables:
321321

322322
- **FILES**: list of R benchmark files.
323323

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`).
325325

326326
</section>
327327

0 commit comments

Comments
 (0)