@@ -264,9 +264,9 @@ times slightly, try using `cargo test --test default`, which will only use the
264
264
265
265
The benchmarking in this crate is made up of many micro-benchmarks. Currently,
266
266
there are two primary sets of benchmarks: the benchmarks that were adopted
267
- at this library's inception (in ` benches /src/misc.rs` ) and a newer set of
267
+ at this library's inception (in ` bench /src/misc.rs` ) and a newer set of
268
268
benchmarks meant to test various optimizations. Specifically, the latter set
269
- contain some analysis and are in ` benches /src/sherlock.rs` . Also, the latter
269
+ contain some analysis and are in ` bench /src/sherlock.rs` . Also, the latter
270
270
set are all executed on the same lengthy input whereas the former benchmarks
271
271
are executed on strings of varying length.
272
272
@@ -292,36 +292,36 @@ library benchmarks (especially RE2).
292
292
If you're hacking on one of the matching engines and just want to see
293
293
benchmarks, then all you need to run is:
294
294
295
- $ ./run- bench rust
295
+ $ ./bench/run rust
296
296
297
297
If you want to compare your results with older benchmarks, then try:
298
298
299
- $ ./run- bench rust | tee old
299
+ $ ./bench/run rust | tee old
300
300
$ ... make it faster
301
- $ ./run- bench rust | tee new
302
- $ cargo- benchcmp old new --improvements
301
+ $ ./bench/run rust | tee new
302
+ $ cargo benchcmp old new --improvements
303
303
304
304
The ` cargo-benchcmp ` utility is available here:
305
305
https://github.com/BurntSushi/cargo-benchcmp
306
306
307
- The ` run- bench` utility can run benchmarks for PCRE and Oniguruma too. See
308
- ` ./run- bench --help ` .
307
+ The ` ./ bench/run ` utility can run benchmarks for PCRE and Oniguruma too. See
308
+ ` ./bench/ bench --help ` .
309
309
310
310
## Dev Docs
311
311
312
312
When digging your teeth into the codebase for the first time, the
313
313
crate documentation can be a great resource. By default ` rustdoc `
314
314
will strip out all documentation of private crate members in an
315
315
effort to help consumers of the crate focus on the * interface*
316
- without having to concern themselves with the * implimentation * .
316
+ without having to concern themselves with the * implementation * .
317
317
Normally this is a great thing, but if you want to start hacking
318
318
on regex internals it is not what you want. Many of the private members
319
319
of this crate are well documented with rustdoc style comments, and
320
320
it would be a shame to miss out on the opportunity that presents.
321
321
You can generate the private docs with:
322
322
323
323
```
324
- > rustdoc --crate-name docs src/lib.rs -o target/doc -L target/debug/deps --no-defaults --passes collapse-docs --passes unindent-comments
324
+ $ rustdoc --crate-name docs src/lib.rs -o target/doc -L target/debug/deps --no-defaults --passes collapse-docs --passes unindent-comments
325
325
```
326
326
327
327
Then just point your browser at ` target/doc/regex/index.html ` .
0 commit comments