Skip to content

Commit

Permalink
don't talk about benchmark mode / test mode in help
Browse files Browse the repository at this point in the history
  • Loading branch information
RalfJung committed Oct 12, 2024
1 parent 2791c12 commit 2783a0f
Show file tree
Hide file tree
Showing 22 changed files with 122 additions and 122 deletions.
20 changes: 10 additions & 10 deletions src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Benchmark all targets in test mode that have the test = true
manifest flag set. By default this includes the library and binaries
built as unittests, and integration tests. Be aware that this will
also build any required dependencies, so the lib target may be built
twice (once as a unittest, and once as a dependency for binaries,
Benchmark all targets that have the test = true manifest flag set.
By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.

Expand All @@ -185,11 +185,11 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--benches
Benchmark all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
Benchmark all targets that have the bench = true manifest flag set.
By default this includes the library and binaries built as
benchmarks, and bench targets. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.

Expand Down
28 changes: 14 additions & 14 deletions src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,26 +89,26 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Build all targets in test mode that have the test = true manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.
Build all targets that have the test = true manifest flag set. By
default this includes the library and binaries built as unittests,
and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as
a unittest, and once as a dependency for binaries, integration
tests, etc.). Targets may be enabled or disabled by setting the test
flag in the manifest settings for the target.

--bench name…
Build the specified benchmark. This flag may be specified multiple
times and supports common Unix glob patterns.

--benches
Build all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.
Build all targets that have the bench = true manifest flag set. By
default this includes the library and binaries built as benchmarks,
and bench targets. Be aware that this will also build any required
dependencies, so the lib target may be built twice (once as a
benchmark, and once as a dependency for binaries, benchmarks, etc.).
Targets may be enabled or disabled by setting the bench flag in the
manifest settings for the target.

--all-targets
Build all targets. This is equivalent to specifying --lib --bins
Expand Down
28 changes: 14 additions & 14 deletions src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,26 +86,26 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Check all targets in test mode that have the test = true manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.
Check all targets that have the test = true manifest flag set. By
default this includes the library and binaries built as unittests,
and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as
a unittest, and once as a dependency for binaries, integration
tests, etc.). Targets may be enabled or disabled by setting the test
flag in the manifest settings for the target.

--bench name…
Check the specified benchmark. This flag may be specified multiple
times and supports common Unix glob patterns.

--benches
Check all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.
Check all targets that have the bench = true manifest flag set. By
default this includes the library and binaries built as benchmarks,
and bench targets. Be aware that this will also build any required
dependencies, so the lib target may be built twice (once as a
benchmark, and once as a dependency for binaries, benchmarks, etc.).
Targets may be enabled or disabled by setting the bench flag in the
manifest settings for the target.

--all-targets
Check all targets. This is equivalent to specifying --lib --bins
Expand Down
28 changes: 14 additions & 14 deletions src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,26 +159,26 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Fix all targets in test mode that have the test = true manifest flag
set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.
Fix all targets that have the test = true manifest flag set. By
default this includes the library and binaries built as unittests,
and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as
a unittest, and once as a dependency for binaries, integration
tests, etc.). Targets may be enabled or disabled by setting the test
flag in the manifest settings for the target.

--bench name…
Fix the specified benchmark. This flag may be specified multiple
times and supports common Unix glob patterns.

--benches
Fix all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.
Fix all targets that have the bench = true manifest flag set. By
default this includes the library and binaries built as benchmarks,
and bench targets. Be aware that this will also build any required
dependencies, so the lib target may be built twice (once as a
benchmark, and once as a dependency for binaries, benchmarks, etc.).
Targets may be enabled or disabled by setting the bench flag in the
manifest settings for the target.

--all-targets
Fix all targets. This is equivalent to specifying --lib --bins
Expand Down
28 changes: 14 additions & 14 deletions src/doc/man/generated_txt/cargo-rustc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,26 +80,26 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Build all targets in test mode that have the test = true manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.
Build all targets that have the test = true manifest flag set. By
default this includes the library and binaries built as unittests,
and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as
a unittest, and once as a dependency for binaries, integration
tests, etc.). Targets may be enabled or disabled by setting the test
flag in the manifest settings for the target.

--bench name…
Build the specified benchmark. This flag may be specified multiple
times and supports common Unix glob patterns.

--benches
Build all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.
Build all targets that have the bench = true manifest flag set. By
default this includes the library and binaries built as benchmarks,
and bench targets. Be aware that this will also build any required
dependencies, so the lib target may be built twice (once as a
benchmark, and once as a dependency for binaries, benchmarks, etc.).
Targets may be enabled or disabled by setting the bench flag in the
manifest settings for the target.

--all-targets
Build all targets. This is equivalent to specifying --lib --bins
Expand Down
24 changes: 12 additions & 12 deletions src/doc/man/generated_txt/cargo-rustdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,24 +80,24 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Document all targets in test mode that have the test = true manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.
Document all targets that have the test = true manifest flag set. By
default this includes the library and binaries built as unittests,
and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as
a unittest, and once as a dependency for binaries, integration
tests, etc.). Targets may be enabled or disabled by setting the test
flag in the manifest settings for the target.

--bench name…
Document the specified benchmark. This flag may be specified
multiple times and supports common Unix glob patterns.

--benches
Document all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
Document all targets that have the bench = true manifest flag set.
By default this includes the library and binaries built as
benchmarks, and bench targets. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.

Expand Down
28 changes: 14 additions & 14 deletions src/doc/man/generated_txt/cargo-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -190,26 +190,26 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Test all targets in test mode that have the test = true manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build
any required dependencies, so the lib target may be built twice
(once as a unittest, and once as a dependency for binaries,
integration tests, etc.). Targets may be enabled or disabled by
setting the test flag in the manifest settings for the target.
Test all targets that have the test = true manifest flag set. By
default this includes the library and binaries built as unittests,
and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as
a unittest, and once as a dependency for binaries, integration
tests, etc.). Targets may be enabled or disabled by setting the test
flag in the manifest settings for the target.

--bench name…
Test the specified benchmark. This flag may be specified multiple
times and supports common Unix glob patterns.

--benches
Test all targets in benchmark mode that have the bench = true
manifest flag set. By default this includes the library and binaries
built as benchmarks, and bench targets. Be aware that this will also
build any required dependencies, so the lib target may be built
twice (once as a benchmark, and once as a dependency for binaries,
benchmarks, etc.). Targets may be enabled or disabled by setting the
bench flag in the manifest settings for the target.
Test all targets that have the bench = true manifest flag set. By
default this includes the library and binaries built as benchmarks,
and bench targets. Be aware that this will also build any required
dependencies, so the lib target may be built twice (once as a
benchmark, and once as a dependency for binaries, benchmarks, etc.).
Targets may be enabled or disabled by setting the bench flag in the
manifest settings for the target.

--all-targets
Test all targets. This is equivalent to specifying --lib --bins
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/includes/options-targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ multiple times and supports common Unix glob patterns.
{{/option}}

{{#option "`--tests`" }}
{{actionverb}} all targets in test mode that have the `test = true` manifest
{{actionverb}} all targets that have the `test = true` manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as a
Expand All @@ -40,7 +40,7 @@ times and supports common Unix glob patterns.
{{/option}}

{{#option "`--benches`" }}
{{actionverb}} all targets in benchmark mode that have the `bench = true`
{{actionverb}} all targets that have the `bench = true`
manifest flag set. By default this includes the library and binaries built
as benchmarks, and bench targets. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as a
Expand Down
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-bench---tests"><a class="option-anchor" href="#option-cargo-bench---tests"></a><code>--tests</code></dt>
<dd class="option-desc">Benchmark all targets in test mode that have the <code>test = true</code> manifest
<dd class="option-desc">Benchmark all targets that have the <code>test = true</code> manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as a
Expand All @@ -208,7 +208,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-bench---benches"><a class="option-anchor" href="#option-cargo-bench---benches"></a><code>--benches</code></dt>
<dd class="option-desc">Benchmark all targets in benchmark mode that have the <code>bench = true</code>
<dd class="option-desc">Benchmark all targets that have the <code>bench = true</code>
manifest flag set. By default this includes the library and binaries built
as benchmarks, and bench targets. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as a
Expand Down
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-build---tests"><a class="option-anchor" href="#option-cargo-build---tests"></a><code>--tests</code></dt>
<dd class="option-desc">Build all targets in test mode that have the <code>test = true</code> manifest
<dd class="option-desc">Build all targets that have the <code>test = true</code> manifest
flag set. By default this includes the library and binaries built as
unittests, and integration tests. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as a
Expand All @@ -123,7 +123,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-build---benches"><a class="option-anchor" href="#option-cargo-build---benches"></a><code>--benches</code></dt>
<dd class="option-desc">Build all targets in benchmark mode that have the <code>bench = true</code>
<dd class="option-desc">Build all targets that have the <code>bench = true</code>
manifest flag set. By default this includes the library and binaries built
as benchmarks, and bench targets. Be aware that this will also build any
required dependencies, so the lib target may be built twice (once as a
Expand Down
Loading

0 comments on commit 2783a0f

Please sign in to comment.