Add documentation for cargo install --ignore-rust-version

rust-lang · Mar 16, 2023 · 1c84d82 · 1c84d82
1 parent ae1c3c2
commit 1c84d82
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/src/doc/man/cargo-install.md b/src/doc/man/cargo-install.md
@@ -179,6 +179,8 @@ See also the `--profile` option for choosing a specific profile by name.
 
 {{> options-profile }}
 
+{{> options-ignore-rust-version }}
+
 {{> options-timings }}
 
 {{/options}}

diff --git a/src/doc/man/generated_txt/cargo-install.txt b/src/doc/man/generated_txt/cargo-install.txt
@@ -215,6 +215,11 @@ OPTIONS
            <https://doc.rust-lang.org/cargo/reference/profiles.html> for more
            details on profiles.
 
+       --ignore-rust-version
+           Install the target even if the selected Rust compiler is older than
+           the required Rust version as configured in the project’s
+           rust-version field.
+
        --timings=fmts
            Output information how long each compilation takes, and track
            concurrency information over time. Accepts an optional

diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md
@@ -248,6 +248,12 @@ See the <a href="../reference/profiles.html">the reference</a> for more details
 
 
 
+<dt class="option-term" id="option-cargo-install---ignore-rust-version"><a class="option-anchor" href="#option-cargo-install---ignore-rust-version"></a><code>--ignore-rust-version</code></dt>
+<dd class="option-desc">Install the target even if the selected Rust compiler is older than the
+required Rust version as configured in the project’s <code>rust-version</code> field.</dd>
+
+
+
 <dt class="option-term" id="option-cargo-install---timings=fmts"><a class="option-anchor" href="#option-cargo-install---timings=fmts"></a><code>--timings=</code><em>fmts</em></dt>
 <dd class="option-desc">Output information how long each compilation takes, and track concurrency
 information over time. Accepts an optional comma-separated list of output

diff --git a/src/etc/man/cargo-install.1 b/src/etc/man/cargo-install.1
@@ -273,6 +273,12 @@ Install with the given profile.
 See the \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
 .RE
 .sp
+\fB\-\-ignore\-rust\-version\fR
+.RS 4
+Install the target even if the selected Rust compiler is older than the
+required Rust version as configured in the project\[cq]s \fBrust\-version\fR field.
+.RE
+.sp
 \fB\-\-timings=\fR\fIfmts\fR
 .RS 4
 Output information how long each compilation takes, and track concurrency