summaryrefslogtreecommitdiffstats
path: root/src/tools/cargo/src/doc/man/cargo-yank.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/cargo/src/doc/man/cargo-yank.md')
-rw-r--r--src/tools/cargo/src/doc/man/cargo-yank.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/src/tools/cargo/src/doc/man/cargo-yank.md b/src/tools/cargo/src/doc/man/cargo-yank.md
new file mode 100644
index 000000000..8ad28ef24
--- /dev/null
+++ b/src/tools/cargo/src/doc/man/cargo-yank.md
@@ -0,0 +1,71 @@
+# cargo-yank(1)
+
+## NAME
+
+cargo-yank --- Remove a pushed crate from the index
+
+## SYNOPSIS
+
+`cargo yank` [_options_] _crate_@_version_\
+`cargo yank` [_options_] `--version` _version_ [_crate_]
+
+## DESCRIPTION
+
+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.
+
+This command requires you to be authenticated with either the `--token` option
+or using {{man "cargo-login" 1}}.
+
+If the crate name is not specified, it will use the package name from the
+current directory.
+
+## OPTIONS
+
+### Yank Options
+
+{{#options}}
+
+{{#option "`--vers` _version_" "`--version` _version_" }}
+The version to yank or un-yank.
+{{/option}}
+
+{{#option "`--undo`" }}
+Undo a yank, putting a version back into the index.
+{{/option}}
+
+{{> options-token }}
+
+{{> options-index }}
+
+{{> options-registry }}
+
+{{/options}}
+
+### Display Options
+
+{{#options}}
+
+{{> options-display }}
+
+{{/options}}
+
+{{> section-options-common }}
+
+{{> section-environment }}
+
+{{> section-exit-status }}
+
+## EXAMPLES
+
+1. Yank a crate from the index:
+
+ cargo yank foo@1.0.7
+
+## SEE ALSO
+{{man "cargo" 1}}, {{man "cargo-login" 1}}, {{man "cargo-publish" 1}}