Skip to content

Commit 790e4ce

Browse files
committed
doc(yank): Tell users about foo@version syntax
1 parent 2806270 commit 790e4ce

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

src/doc/man/cargo-yank.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ cargo-yank - Remove a pushed crate from the index
66

77
## SYNOPSIS
88

9+
`cargo yank` [_options_] _crate_@_version_\
910
`cargo yank` [_options_] `--version` _version_ [_crate_]
1011

1112
## DESCRIPTION
@@ -64,7 +65,7 @@ Undo a yank, putting a version back into the index.
6465

6566
1. Yank a crate from the index:
6667

67-
cargo yank --version 1.0.7 foo
68+
cargo yank foo@1.0.7
6869

6970
## SEE ALSO
7071
{{man "cargo" 1}}, {{man "cargo-login" 1}}, {{man "cargo-publish" 1}}

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ NAME
44
cargo-yank - Remove a pushed crate from the index
55

66
SYNOPSIS
7+
cargo yank [options] crate@version
78
cargo yank [options] --version version [crate]
89

910
DESCRIPTION
@@ -104,7 +105,7 @@ EXIT STATUS
104105
EXAMPLES
105106
1. Yank a crate from the index:
106107

107-
cargo yank --version 1.0.7 foo
108+
cargo yank foo@1.0.7
108109

109110
SEE ALSO
110111
cargo(1), cargo-login(1), cargo-publish(1)

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ cargo-yank - Remove a pushed crate from the index
66

77
## SYNOPSIS
88

9+
`cargo yank` [_options_] _crate_@_version_\
910
`cargo yank` [_options_] `--version` _version_ [_crate_]
1011

1112
## DESCRIPTION
@@ -140,7 +141,7 @@ details on environment variables that Cargo reads.
140141

141142
1. Yank a crate from the index:
142143

143-
cargo yank --version 1.0.7 foo
144+
cargo yank foo@1.0.7
144145

145146
## SEE ALSO
146147
[cargo(1)](cargo.html), [cargo-login(1)](cargo-login.html), [cargo-publish(1)](cargo-publish.html)

src/etc/man/cargo-yank.1

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
.SH "NAME"
77
cargo\-yank \- Remove a pushed crate from the index
88
.SH "SYNOPSIS"
9+
\fBcargo yank\fR [\fIoptions\fR] \fIcrate\fR@\fIversion\fR
10+
.br
911
\fBcargo yank\fR [\fIoptions\fR] \fB\-\-version\fR \fIversion\fR [\fIcrate\fR]
1012
.SH "DESCRIPTION"
1113
The yank command removes a previously published crate's version from the
@@ -139,7 +141,7 @@ details on environment variables that Cargo reads.
139141
.sp
140142
.RS 4
141143
.nf
142-
cargo yank \-\-version 1.0.7 foo
144+
cargo yank foo@1.0.7
143145
.fi
144146
.RE
145147
.RE

0 commit comments

Comments
 (0)