MAN page from openSUSE Leap 42 cargo-1.31.1-186.1.x86_64.rpm
CARGO\-BENCH
Section: Cargo Manual (1)
Updated: May 2016
Index NAME
cargo-bench - Execute benchmarks of a package
SYNOPSIS
I]cargo bench] [OPTIONS] [--] [<ARGS>...]
DESCRIPTION
Execute all benchmarks of a local package.
All of the trailing arguments are passed to the benchmark binariesgenerated for filtering benchmarks and generally providing optionsconfiguring how they run.
If the B]--package] argument is given, then I]SPEC] is apackage id specification which indicates which package should be built.If it is not given, then the current package is built.For more information on I]SPEC] and its format, see the "cargohelp pkgid" command.
The B]--jobs] argument affects the building of the benchmarkexecutable but does not affect how many jobs are used when running thebenchmarks.
Compilation can be customized with the [aq]bench[aq] profile in themanifest.
OPTIONS
- -h, --help
- Print this message.
- --lib
- Benchmark only this package[aq]s library.
- --bin I]NAME]
- Benchmark only the specified binary.
- --example I]NAME]
- Benchmark only the specified example.
- --test I]NAME]
- Benchmark only the specified test target.
- --bench I]NAME]
- Benchmark only the specified bench target.
- --no-run
- Compile, but don[aq]t run benchmarks.
- -p I]SPEC], --package I]SPEC ...]
- Package to benchmarks for.
- -j I]IN], --jobs I]IN]
- Number of parallel jobs, defaults to # of CPUs.
- --release
- Build artifacts in release mode, with optimizations.
- --features I]FEATURES]
- Space-separated list of features to also build.
- --all-features
- Build all available features.
- --no-default-features
- Do not build the C]default] feature.
- --target I]TRIPLE]
- Build for the target triple.
- --manifest-path I]PATH]
- Path to the Cargo.toml to compile.
- -v, --verbose
- Use verbose output.
- -q, --quiet
- No output printed to stdout.
- --color I]WHEN]
- Coloring: auto, always, never.
EXAMPLES
Execute all the benchmarks of the current package
C]$ cargo bench]
Execute the BENCH benchmark
C]$ cargo bench --bench BENCH]
SEE ALSO
cargo(1), cargo-build(1), cargo-test(1)
COPYRIGHT
This work is dual-licensed under Apache 2.0 and MIT terms.See I]COPYRIGHT] file in the cargo source distribution.
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- EXAMPLES
- SEE ALSO
- COPYRIGHT
This document was created byman2html,using the manual pages.
