Skip to content

Commit

Permalink
Clarify the required positions of the bench_local options.
Browse files Browse the repository at this point in the history
Fixes #290.
  • Loading branch information
nnethercote committed Oct 10, 2018
1 parent 4185fcf commit 6e12dc1
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,25 +74,24 @@ depending on the speed of your machine.

### Benchmarking options

`--filter $STR` can be used to run a subset of the benchmarks. `$STR` is a
substring of the name of the benchmark(s) you wish to run.

`--exclude $STR` is the inverse of `--filter`. `$STR` is a substring of the
name of the benchmark(s) you wish to skip.

`--builds $BUILDS` can be used to select what kind of builds are profiled. The
possible choices are one or more (comma-separated) of `Check`, `Debug`, `Opt`,
and `All` (the default).

`--runs $RUNS` can be used to select what profiling runs are done for each
build. The possible choices are one or more (comma-separated) of `Clean`,
`Nll`, `BaseIncr`, `CleanIncr`, `PatchedIncrs`, and `All` (the default). Note
that `BaseIncr` is always run (even if not requested) if either of `CleanIncr`
or `PatchedIncrs` are run.

`--sync-git` can be passed to make the collector sync with the remote
repository before and after committing. This is usually not useful for
individual Rust compiler developers.
The following options must appear before `bench_local` in the command.
- `--filter $STR` can be used to run a subset of the benchmarks. `$STR` is a
substring of the name of the benchmark(s) you wish to run.
- `--exclude $STR` is the inverse of `--filter`. `$STR` is a substring of the
name of the benchmark(s) you wish to skip.
- `--sync-git` can be passed to make the collector sync with the remote
repository before and after committing. This is usually not useful for
individual Rust compiler developers.

The following options must appear after `bench_local` in the command.
- `--builds $BUILDS` can be used to select what kind of builds are profiled.
The possible choices are one or more (comma-separated) of `Check`, `Debug`,
`Opt`, and `All` (the default).
- `--runs $RUNS` can be used to select what profiling runs are done for each
build. The possible choices are one or more (comma-separated) of `Clean`,
`Nll`, `BaseIncr`, `CleanIncr`, `PatchedIncrs`, and `All` (the default). Note
that `BaseIncr` is always run (even if not requested) if either of
`CleanIncr` or `PatchedIncrs` are run.

### Comparing different versions on your own machine

Expand Down

0 comments on commit 6e12dc1

Please sign in to comment.