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 6df3254
Show file tree
Hide file tree
Showing 22 changed files with 44 additions and 44 deletions.
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Benchmark all targets in test mode that have the test = true
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
Expand All @@ -185,7 +185,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--benches
Benchmark all targets in benchmark mode that have the bench = true
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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Build all targets in test mode that have the test = true manifest
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
Expand All @@ -102,7 +102,7 @@ OPTIONS
times and supports common Unix glob patterns.

--benches
Build all targets in benchmark mode that have the bench = true
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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Check all targets in test mode that have the test = true manifest
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
Expand All @@ -99,7 +99,7 @@ OPTIONS
times and supports common Unix glob patterns.

--benches
Check all targets in benchmark mode that have the bench = true
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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Fix all targets in test mode that have the test = true manifest flag
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
Expand All @@ -172,7 +172,7 @@ OPTIONS
times and supports common Unix glob patterns.

--benches
Fix all targets in benchmark mode that have the bench = true
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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-rustc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Build all targets in test mode that have the test = true manifest
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
Expand All @@ -93,7 +93,7 @@ OPTIONS
times and supports common Unix glob patterns.

--benches
Build all targets in benchmark mode that have the bench = true
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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-rustdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Document all targets in test mode that have the test = true manifest
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
Expand All @@ -93,7 +93,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--benches
Document all targets in benchmark mode that have the bench = true
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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ OPTIONS
multiple times and supports common Unix glob patterns.

--tests
Test all targets in test mode that have the test = true manifest
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
Expand All @@ -203,7 +203,7 @@ OPTIONS
times and supports common Unix glob patterns.

--benches
Test all targets in benchmark mode that have the bench = true
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
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
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-check---tests"><a class="option-anchor" href="#option-cargo-check---tests"></a><code>--tests</code></dt>
<dd class="option-desc">Check all targets in test mode that have the <code>test = true</code> manifest
<dd class="option-desc">Check 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 @@ -119,7 +119,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-check---benches"><a class="option-anchor" href="#option-cargo-check---benches"></a><code>--benches</code></dt>
<dd class="option-desc">Check all targets in benchmark mode that have the <code>bench = true</code>
<dd class="option-desc">Check 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-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-fix---tests"><a class="option-anchor" href="#option-cargo-fix---tests"></a><code>--tests</code></dt>
<dd class="option-desc">Fix all targets in test mode that have the <code>test = true</code> manifest
<dd class="option-desc">Fix 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 @@ -199,7 +199,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-fix---benches"><a class="option-anchor" href="#option-cargo-fix---benches"></a><code>--benches</code></dt>
<dd class="option-desc">Fix all targets in benchmark mode that have the <code>bench = true</code>
<dd class="option-desc">Fix 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-rustc.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-rustc---tests"><a class="option-anchor" href="#option-cargo-rustc---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 @@ -112,7 +112,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-rustc---benches"><a class="option-anchor" href="#option-cargo-rustc---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
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-rustdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-rustdoc---tests"><a class="option-anchor" href="#option-cargo-rustdoc---tests"></a><code>--tests</code></dt>
<dd class="option-desc">Document all targets in test mode that have the <code>test = true</code> manifest
<dd class="option-desc">Document 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 @@ -118,7 +118,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-rustdoc---benches"><a class="option-anchor" href="#option-cargo-rustdoc---benches"></a><code>--benches</code></dt>
<dd class="option-desc">Document all targets in benchmark mode that have the <code>bench = true</code>
<dd class="option-desc">Document 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-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ multiple times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-test---tests"><a class="option-anchor" href="#option-cargo-test---tests"></a><code>--tests</code></dt>
<dd class="option-desc">Test all targets in test mode that have the <code>test = true</code> manifest
<dd class="option-desc">Test 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 @@ -221,7 +221,7 @@ times and supports common Unix glob patterns.</dd>


<dt class="option-term" id="option-cargo-test---benches"><a class="option-anchor" href="#option-cargo-test---benches"></a><code>--benches</code></dt>
<dd class="option-desc">Test all targets in benchmark mode that have the <code>bench = true</code>
<dd class="option-desc">Test 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/etc/man/cargo-bench.1
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ multiple times and supports common Unix glob patterns.
.sp
\fB\-\-tests\fR
.RS 4
Benchmark all targets in test mode that have the \fBtest = true\fR manifest
Benchmark all targets that have the \fBtest = true\fR 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 @@ -225,7 +225,7 @@ times and supports common Unix glob patterns.
.sp
\fB\-\-benches\fR
.RS 4
Benchmark all targets in benchmark mode that have the \fBbench = true\fR
Benchmark all targets that have the \fBbench = true\fR
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/etc/man/cargo-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ multiple times and supports common Unix glob patterns.
.sp
\fB\-\-tests\fR
.RS 4
Build all targets in test mode that have the \fBtest = true\fR manifest
Build all targets that have the \fBtest = true\fR 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 @@ -124,7 +124,7 @@ times and supports common Unix glob patterns.
.sp
\fB\-\-benches\fR
.RS 4
Build all targets in benchmark mode that have the \fBbench = true\fR
Build all targets that have the \fBbench = true\fR
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/etc/man/cargo-check.1
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ multiple times and supports common Unix glob patterns.
.sp
\fB\-\-tests\fR
.RS 4
Check all targets in test mode that have the \fBtest = true\fR manifest
Check all targets that have the \fBtest = true\fR 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 @@ -120,7 +120,7 @@ times and supports common Unix glob patterns.
.sp
\fB\-\-benches\fR
.RS 4
Check all targets in benchmark mode that have the \fBbench = true\fR
Check all targets that have the \fBbench = true\fR
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/etc/man/cargo-fix.1
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ multiple times and supports common Unix glob patterns.
.sp
\fB\-\-tests\fR
.RS 4
Fix all targets in test mode that have the \fBtest = true\fR manifest
Fix all targets that have the \fBtest = true\fR 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 @@ -215,7 +215,7 @@ times and supports common Unix glob patterns.
.sp
\fB\-\-benches\fR
.RS 4
Fix all targets in benchmark mode that have the \fBbench = true\fR
Fix all targets that have the \fBbench = true\fR
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 6df3254

Please sign in to comment.