Skip to content

Commit

Permalink
doc(cargo-update): --precise to allow yanked versions
Browse files Browse the repository at this point in the history
  • Loading branch information
weihanglo committed Jan 21, 2024
1 parent 35345f2 commit 7eb0ba2
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 2 deletions.
4 changes: 4 additions & 0 deletions src/doc/man/cargo-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ Cannot be used with `--precise`.
When used with _spec_, allows you to specify a specific version number to set
the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).

While not recommended, specifying a yanked version of a package is allowed (nightly only).
When possible, try other non-yanked SemVer-compatible versions, or seek helps
from the maintainers of the package.
{{/option}}

{{#option "`-w`" "`--workspace`" }}
Expand Down
5 changes: 5 additions & 0 deletions src/doc/man/generated_txt/cargo-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ OPTIONS
to set the package to. If the package comes from a git repository,
this can be a git revision (such as a SHA hash or tag).

While not recommended, specifying a yanked version of a package is
allowed (nightly only). When possible, try other non-yanked
SemVer-compatible versions, or seek helps from the maintainers of
the package.

-w, --workspace
Attempt to update only packages defined in the workspace. Other
packages are updated only if they don’t already exist in the
Expand Down
5 changes: 4 additions & 1 deletion src/doc/src/commands/cargo-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ Cannot be used with <code>--precise</code>.</dd>
<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>
<dd class="option-desc">When used with <em>spec</em>, allows you to specify a specific version number to set
the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).</dd>
revision (such as a SHA hash or tag).</p>
<p>While not recommended, specifying a yanked version of a package is allowed (nightly only).
When possible, try other non-yanked SemVer-compatible versions, or seek helps
from the maintainers of the package.</dd>


<dt class="option-term" id="option-cargo-update--w"><a class="option-anchor" href="#option-cargo-update--w"></a><code>-w</code></dt>
Expand Down
4 changes: 3 additions & 1 deletion src/doc/src/reference/resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,9 +325,11 @@ the `links` field if your library is in common use.

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

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

## Dependency updates

Expand Down
4 changes: 4 additions & 0 deletions src/etc/man/cargo-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Cannot be used with \fB\-\-precise\fR\&.
When used with \fIspec\fR, allows you to specify a specific version number to set
the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).
.sp
While not recommended, specifying a yanked version of a package is allowed (nightly only).
When possible, try other non\-yanked SemVer\-compatible versions, or seek helps
from the maintainers of the package.
.RE
.sp
\fB\-w\fR,
Expand Down

0 comments on commit 7eb0ba2

Please sign in to comment.