Skip to content

Commit

Permalink
Update docs for -Zmultitarget stabilization
Browse files Browse the repository at this point in the history
  • Loading branch information
weihanglo committed Jul 16, 2022
1 parent 5d01364 commit df53131
Show file tree
Hide file tree
Showing 51 changed files with 92 additions and 67 deletions.
1 change: 1 addition & 0 deletions src/doc/man/cargo-bench.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-bench(1)
{{*set actionverb="Benchmark"}}
{{*set nouns="benchmarks"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-build.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-build(1)
{{*set actionverb="Build"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-check(1)
{{*set actionverb="Check"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-clean.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-clean(1)
{{*set actionverb="Clean"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-doc(1)
{{*set actionverb="Document"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-fetch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-fetch(1)
{{*set actionverb="Fetch"}}
{{*set target-default-to-all-arch=true}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-fix.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-fix(1)
{{*set actionverb="Fix"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-package.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-package(1)
{{*set actionverb="Package"}}
{{*set noall=true}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-publish.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-publish(1)
{{*set actionverb="Publish"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-rustc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-rustc(1)
{{*set actionverb="Build"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-rustdoc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-rustdoc(1)
{{*set actionverb="Document"}}
{{*set multitarget=true}}

## NAME

Expand Down
1 change: 1 addition & 0 deletions src/doc/man/cargo-test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-test(1)
{{*set actionverb="Test"}}
{{*set nouns="tests"}}
{{*set multitarget=true}}

## NAME

Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ OPTIONS
Benchmark for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ OPTIONS
Build for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,8 @@ OPTIONS
Check for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-clean.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ OPTIONS
Clean for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ OPTIONS
Document for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ OPTIONS
Fetch for the given architecture. The default is all architectures.
The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,8 @@ OPTIONS
Fix for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-package.txt
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ OPTIONS
Package for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-publish.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ OPTIONS
Publish for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-rustc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ OPTIONS
Build for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-rustdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ OPTIONS
Document for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,8 @@ OPTIONS
Test for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
a list of supported targets.
a list of supported targets. This flag may be specified multiple
times.

This may also be specified with the build.target config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
1 change: 1 addition & 0 deletions src/doc/man/includes/options-target-triple.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
{{~/if}} The general format of the triple is
`<arch><sub>-<vendor>-<sys>-<abi>`. Run `rustc --print target-list` for a
list of supported targets.
{{~#if multitarget }} This flag may be specified multiple times. {{~/if}}

This may also be specified with the `build.target`
[config value](../reference/config.html).
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@




## NAME

cargo-bench - Execute benchmarks of a package
Expand Down Expand Up @@ -255,7 +256,7 @@ be specified multiple times, which enables all specified features.</dd>
<dt class="option-term" id="option-cargo-bench---target"><a class="option-anchor" href="#option-cargo-bench---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Benchmark for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-build.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-build(1)



## NAME

cargo-build - Compile the current package
Expand Down Expand Up @@ -182,7 +183,7 @@ be specified multiple times, which enables all specified features.</dd>
<dt class="option-term" id="option-cargo-build---target"><a class="option-anchor" href="#option-cargo-build---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Build for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-check.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-check(1)



## NAME

cargo-check - Check the current package
Expand Down Expand Up @@ -177,7 +178,7 @@ be specified multiple times, which enables all specified features.</dd>
<dt class="option-term" id="option-cargo-check---target"><a class="option-anchor" href="#option-cargo-check---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Check for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-clean.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-clean(1)



## NAME

cargo-clean - Remove generated artifacts
Expand Down Expand Up @@ -59,7 +60,7 @@ Defaults to <code>target</code> in the root of the workspace.</dd>
<dt class="option-term" id="option-cargo-clean---target"><a class="option-anchor" href="#option-cargo-clean---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Clean for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-doc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-doc(1)



## NAME

cargo-doc - Build a package's documentation
Expand Down Expand Up @@ -155,7 +156,7 @@ be specified multiple times, which enables all specified features.</dd>
<dt class="option-term" id="option-cargo-doc---target"><a class="option-anchor" href="#option-cargo-doc---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Document for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@




## NAME

cargo-fetch - Fetch dependencies of a package from the network
Expand Down Expand Up @@ -34,7 +35,7 @@ you plan to use Cargo without a network with the `--offline` flag.
<dt class="option-term" id="option-cargo-fetch---target"><a class="option-anchor" href="#option-cargo-fetch---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Fetch for the given architecture. The default is all architectures. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-fix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-fix(1)



## NAME

cargo-fix - Automatically fix lint warnings reported by rustc
Expand Down Expand Up @@ -257,7 +258,7 @@ be specified multiple times, which enables all specified features.</dd>
<dt class="option-term" id="option-cargo-fix---target"><a class="option-anchor" href="#option-cargo-fix---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Fix for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@




## NAME

cargo-package - Assemble the local package into a distributable tarball
Expand Down Expand Up @@ -133,7 +134,7 @@ single quotes or double quotes around each pattern.</dd>
<dt class="option-term" id="option-cargo-package---target"><a class="option-anchor" href="#option-cargo-package---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Package for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-publish.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-publish(1)



## NAME

cargo-publish - Upload a package to the registry
Expand Down Expand Up @@ -99,7 +100,7 @@ format.</dd>
<dt class="option-term" id="option-cargo-publish---target"><a class="option-anchor" href="#option-cargo-publish---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Publish for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-rustc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-rustc(1)



## NAME

cargo-rustc - Compile the current package, and pass extra options to the compiler
Expand Down Expand Up @@ -169,7 +170,7 @@ be specified multiple times, which enables all specified features.</dd>
<dt class="option-term" id="option-cargo-rustc---target"><a class="option-anchor" href="#option-cargo-rustc---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Build for the given architecture. The default is the host architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
list of supported targets. This flag may be specified multiple times.</p>
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
<p>Note that specifying this flag makes Cargo run in a different mode where the
Expand Down
Loading

0 comments on commit df53131

Please sign in to comment.