Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify Implications of Cargo Yank #11071

Closed
wants to merge 7 commits into from
Closed

Clarify Implications of Cargo Yank #11071

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9065c87
Update cargo-yank.md
tustvold Sep 10, 2022
17c711c
Review feedback
tustvold Sep 10, 2022
aa1f590
Tweak wording
tustvold Sep 10, 2022
e48b16f
Remove empty files
tustvold Sep 10, 2022
af6b722
Fix copypasta
tustvold Sep 10, 2022
d227ad6
Review feedback
tustvold Sep 27, 2022
1cba8b7
Fix typo
tustvold Sep 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/doc/src/commands/cargo-yank.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@ The yank command removes a previously published crate's version from the
server's index. This command does not delete any data, and the crate will
still be available for download via the registry's download link.

Note that existing crates locked to a yanked version will still be able to
download the yanked version to use it. Cargo will, however, not allow any new
crates to be locked to any yanked version.
However, yanking a release will prevent compilation of any dependent crates
with a semver constraint that no can no longer be satisfied by a non-yanked
version of this crate.

The only exception to this is crates locked to a yanked version by a lockfile,
these will still be able to download the yanked version to use it. Cargo
will, however, not allow any new crates to be locked to any yanked version,
including when resolving semver constraints in the abscence of a lockfile.

This command requires you to be authenticated with either the `--token` option
or using [cargo-login(1)](cargo-login.html).
Expand Down