Skip to content

Commit 6973294

Browse files
committed
docs: document --cargo-config flag
1 parent 20bb3ba commit 6973294

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

collector/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,10 @@ The following options alter the behaviour of the `bench_local` subcommand.
115115
by `rustup` will be used. This is usually fine, though in rare cases it may
116116
cause local results to not exactly match production results, because Cargo
117117
sometimes begins passing (or stops passing) various flags to rustc.
118+
- `--cargo-config <CONFIG>`: a Cargo configuration value or a path to a Cargo
119+
configuration file. This flag can be specified multiple times, and will be
120+
passed to the Cargo executable as the value of the flag
121+
[`--config`](https://doc.rust-lang.org/nightly/cargo/commands/cargo.html#option-cargo---config).
118122
- `--db <DATABASE>`: a path (relative or absolute) to a sqlite database file in
119123
which the timing data will be placed. It will be created if it does not
120124
already exist. The default is `results.db`. Alternatively, the collector
@@ -195,7 +199,7 @@ and discover all benchmarks within them. If you only want to run benchmark(s) fr
195199
you can use this to speed up the runtime benchmarking or profiling commands.
196200

197201
The `bench_runtime_local` command also shares some options with the `bench_local` command, notably
198-
`--id`, `--db`, `--cargo`, `--include`, `--exclude` and `--iterations`.
202+
`--id`, `--db`, `--cargo`, `--cargo-config`, `--include`, `--exclude` and `--iterations`.
199203

200204
### How to view the measurements on your own machine
201205

@@ -465,6 +469,7 @@ fashion to the one chosen for `bench_local`.
465469

466470
The following options alter the behaviour of the `profile_local` subcommand.
467471
- `--cargo <CARGO>`: as for `bench_local`.
472+
- `--cargo-config <CONFIG>`: as for `bench_local`.
468473
- `--exclude <EXCLUDE>`: as for `bench_local`.
469474
- `--id <ID>`: an identifer that will form part of the output filenames.
470475
- `--include <INCLUDE>`: as for `bench_local`.

0 commit comments

Comments
 (0)