Skip to content

Commit

Permalink
Fix errors in cargo fetch usage guide
Browse files Browse the repository at this point in the history
Co-authored-by: Caleb Maclennan <caleb@alerque.com>
  • Loading branch information
piggynl and alerque committed Feb 17, 2022
1 parent ea2a21c commit 08734a6
Show file tree
Hide file tree
Showing 31 changed files with 40 additions and 64 deletions.
3 changes: 2 additions & 1 deletion src/doc/man/cargo-fetch.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# cargo-fetch(1)
{{*set actionverb="Fetch"}}
{{*set target-default-to-all-arch=true}}

## NAME

Expand All @@ -13,7 +14,7 @@ cargo-fetch - Fetch dependencies of a package from the network

If a `Cargo.lock` file is available, this command will ensure that all of the
git dependencies and/or registry dependencies are downloaded and locally
available. Subsequent Cargo commands never touch the network after a `cargo
available. Subsequent Cargo commands will be able to run offline after a `cargo
fetch` unless the lock file changes.

If the lock file is not available, then this command will generate the lock
Expand Down
6 changes: 3 additions & 3 deletions src/doc/man/generated_txt/cargo-fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SYNOPSIS
DESCRIPTION
If a Cargo.lock file is available, this command will ensure that all of
the git dependencies and/or registry dependencies are downloaded and
locally available. Subsequent Cargo commands never touch the network
locally available. Subsequent Cargo commands will be able to run offline
after a cargo fetch unless the lock file changes.

If the lock file is not available, then this command will generate the
Expand All @@ -25,8 +25,8 @@ DESCRIPTION
OPTIONS
Fetch options
--target triple
Fetch for the given architecture. The default is the host
architecture. The general format of the triple is
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.

Expand Down
6 changes: 4 additions & 2 deletions src/doc/man/includes/options-target-triple.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{{#option "`--target` _triple_"}}
{{actionverb}} for the given architecture. The default is the host
architecture. The general format of the triple is
{{actionverb}} for the given architecture.
{{~#if target-default-to-all-arch}} The default is all architectures.
{{~else}} The default is the host architecture.
{{~/if}} The general format of the triple is
`<arch><sub>-<vendor>-<sys>-<abi>`. Run `rustc --print target-list` for a
list of supported targets.

Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
6 changes: 3 additions & 3 deletions src/doc/src/commands/cargo-fetch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# cargo-fetch(1)



## NAME

cargo-fetch - Fetch dependencies of a package from the network
Expand All @@ -13,7 +14,7 @@ cargo-fetch - Fetch dependencies of a package from the network

If a `Cargo.lock` file is available, this command will ensure that all of the
git dependencies and/or registry dependencies are downloaded and locally
available. Subsequent Cargo commands never touch the network after a `cargo
available. Subsequent Cargo commands will be able to run offline after a `cargo
fetch` unless the lock file changes.

If the lock file is not available, then this command will generate the lock
Expand All @@ -31,8 +32,7 @@ you plan to use Cargo without a network with the `--offline` flag.

<dl>
<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 the host
architecture. The general format of the triple is
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,8 +254,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<dt class="option-term" id="option-cargo-install---target"><a class="option-anchor" href="#option-cargo-install---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Install for the given architecture. The default is the host
architecture. The general format of the triple is
<dd class="option-desc">Install 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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,7 @@ single quotes or double quotes around each pattern.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,7 @@ format.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<dt class="option-term" id="option-cargo-run---target"><a class="option-anchor" href="#option-cargo-run---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Run for the given architecture. The default is the host
architecture. The general format of the triple is
<dd class="option-desc">Run 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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-rustc.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-rustdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<dt class="option-term" id="option-cargo-rustdoc---target"><a class="option-anchor" href="#option-cargo-rustdoc---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
<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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/doc/src/commands/cargo-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,7 @@ be specified multiple times, which enables all specified features.</dd>
<dl>

<dt class="option-term" id="option-cargo-test---target"><a class="option-anchor" href="#option-cargo-test---target"></a><code>--target</code> <em>triple</em></dt>
<dd class="option-desc">Test for the given architecture. The default is the host
architecture. The general format of the triple is
<dd class="option-desc">Test 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>
<p>This may also be specified with the <code>build.target</code>
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-bench.1
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Benchmark for the given architecture. The default is the host
architecture. The general format of the triple is
Benchmark for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Build for the given architecture. The default is the host
architecture. The general format of the triple is
Build for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-check.1
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Check for the given architecture. The default is the host
architecture. The general format of the triple is
Check for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-clean.1
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ Defaults to \fBtarget\fR in the root of the workspace.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Clean for the given architecture. The default is the host
architecture. The general format of the triple is
Clean for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-doc.1
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Document for the given architecture. The default is the host
architecture. The general format of the triple is
Document for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
5 changes: 2 additions & 3 deletions src/etc/man/cargo-fetch.1
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cargo\-fetch \- Fetch dependencies of a package from the network
.SH "DESCRIPTION"
If a \fBCargo.lock\fR file is available, this command will ensure that all of the
git dependencies and/or registry dependencies are downloaded and locally
available. Subsequent Cargo commands never touch the network after a \fBcargo fetch\fR unless the lock file changes.
available. Subsequent Cargo commands will be able to run offline after a \fBcargo fetch\fR unless the lock file changes.
.sp
If the lock file is not available, then this command will generate the lock
file before fetching the dependencies.
Expand All @@ -25,8 +25,7 @@ you plan to use Cargo without a network with the \fB\-\-offline\fR flag.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Fetch for the given architecture. The default is the host
architecture. The general format of the triple is
Fetch for the given architecture. The default is all architectures. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-fix.1
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Fix for the given architecture. The default is the host
architecture. The general format of the triple is
Fix for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-install.1
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Install for the given architecture. The default is the host
architecture. The general format of the triple is
Install for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-package.1
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ single quotes or double quotes around each pattern.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Package for the given architecture. The default is the host
architecture. The general format of the triple is
Package for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-publish.1
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,7 @@ format.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Publish for the given architecture. The default is the host
architecture. The general format of the triple is
Publish for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-run.1
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Run for the given architecture. The default is the host
architecture. The general format of the triple is
Run for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-rustc.1
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Build for the given architecture. The default is the host
architecture. The general format of the triple is
Build for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-rustdoc.1
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Document for the given architecture. The default is the host
architecture. The general format of the triple is
Document for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down
3 changes: 1 addition & 2 deletions src/etc/man/cargo-test.1
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,7 @@ Do not activate the \fBdefault\fR feature of the selected packages.
.sp
\fB\-\-target\fR \fItriple\fR
.RS 4
Test for the given architecture. The default is the host
architecture. The general format of the triple is
Test for the given architecture. The default is the host architecture. The general format of the triple is
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
list of supported targets.
.sp
Expand Down

0 comments on commit 08734a6

Please sign in to comment.