Skip to content

Commit c288f75

Browse files
committed
[benchmark] Updated docs with info on test numbers
* Description of listing and running tests by ordinal numbers
1 parent 7f89426 commit c288f75

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

benchmark/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,17 @@ Using the Benchmark Driver
107107

108108
### Note
109109
As a shortcut, you can also refer to benchmarks by their ordinal numbers.
110-
The regular `--list` option does not provide these, but you can run:
111-
* `$ ./Benchmark_O --list --run-all | tail -n +2 | nl`
112-
You can use ordinal numbers instead of test names like this:
110+
These are printed out together with benchmark names and tags using the
111+
`--list` parameter. For a complete list of all available performance tests run
112+
* `$ ./Benchmark_O --list --skip-tags=`
113+
114+
You can use test numbers instead of test names like this:
113115
* `$ ./Benchmark_O 1 42`
114116
* `$ ./Benchmark_Driver run 1 42`
115117

118+
Test numbers are not stable in the long run, adding and removing tests from the
119+
benchmark suite will reorder them, but they are stable for a given build.
120+
116121
Using the Harness Generator
117122
---------------------------
118123

0 commit comments

Comments
 (0)