Skip to content

Commit 8c392fd

Browse files
committed
doc(cargo-update): --precise to allow yanked versions
1 parent 3f2f4ed commit 8c392fd

File tree

5 files changed

+20
-2
lines changed

5 files changed

+20
-2
lines changed

src/doc/man/cargo-update.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ Cannot be used with `--precise`.
4242
When used with _spec_, allows you to specify a specific version number to set
4343
the package to. If the package comes from a git repository, this can be a git
4444
revision (such as a SHA hash or tag).
45+
46+
While not recommended, you can specify a yanked version of a package (nightly only).
47+
When possible, try other non-yanked SemVer-compatible versions or seek help
48+
from the maintainers of the package.
4549
{{/option}}
4650

4751
{{#option "`-w`" "`--workspace`" }}

src/doc/man/generated_txt/cargo-update.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ OPTIONS
3535
to set the package to. If the package comes from a git repository,
3636
this can be a git revision (such as a SHA hash or tag).
3737

38+
While not recommended, you can specify a yanked version of a package
39+
(nightly only). When possible, try other non-yanked
40+
SemVer-compatible versions or seek help from the maintainers of the
41+
package.
42+
3843
-w, --workspace
3944
Attempt to update only packages defined in the workspace. Other
4045
packages are updated only if they don’t already exist in the

src/doc/src/commands/cargo-update.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ Cannot be used with <code>--precise</code>.</dd>
3939
<dt class="option-term" id="option-cargo-update---precise"><a class="option-anchor" href="#option-cargo-update---precise"></a><code>--precise</code> <em>precise</em></dt>
4040
<dd class="option-desc">When used with <em>spec</em>, allows you to specify a specific version number to set
4141
the package to. If the package comes from a git repository, this can be a git
42-
revision (such as a SHA hash or tag).</dd>
42+
revision (such as a SHA hash or tag).</p>
43+
<p>While not recommended, you can specify a yanked version of a package (nightly only).
44+
When possible, try other non-yanked SemVer-compatible versions or seek help
45+
from the maintainers of the package.</dd>
4346

4447

4548
<dt class="option-term" id="option-cargo-update--w"><a class="option-anchor" href="#option-cargo-update--w"></a><code>-w</code></dt>

src/doc/src/reference/resolver.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,11 @@ the `links` field if your library is in common use.
325325

326326
[Yanked releases][yank] are those that are marked that they should not be
327327
used. When the resolver is building the graph, it will ignore all yanked
328-
releases unless they already exist in the `Cargo.lock` file.
328+
releases unless they already exist in the `Cargo.lock` file or are explicitly
329+
requested by the [`--precise`] flag of `cargo update` (nightly only).
329330

330331
[yank]: publishing.md#cargo-yank
332+
[`--precise`]: ../commands/cargo-update.md#option-cargo-update---precise
331333

332334
## Dependency updates
333335

src/etc/man/cargo-update.1

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ Cannot be used with \fB\-\-precise\fR\&.
3939
When used with \fIspec\fR, allows you to specify a specific version number to set
4040
the package to. If the package comes from a git repository, this can be a git
4141
revision (such as a SHA hash or tag).
42+
.sp
43+
While not recommended, you can specify a yanked version of a package (nightly only).
44+
When possible, try other non\-yanked SemVer\-compatible versions or seek help
45+
from the maintainers of the package.
4246
.RE
4347
.sp
4448
\fB\-w\fR,

0 commit comments

Comments
 (0)