Skip to content

Commit 2aea4d0

Browse files
committed
doc(yank): make it more cohesive
1 parent e908f6a commit 2aea4d0

File tree

4 files changed

+42
-30
lines changed

4 files changed

+42
-30
lines changed

src/doc/man/cargo-yank.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,16 @@ A common workflow is to yank a crate having already published a semver
6161
compatible version, to reduce the probability of preventing dependent
6262
crates from compiling.
6363

64-
To address copyright, licensing, or personal data issues with your published
65-
crate, contact the maintainers of the registry you used. For crates.io, refer
66-
to their [policies] and contact them at <[email protected]>.
67-
68-
If your credentials have been leaked, the recommended process is to revoke them
69-
immediately. Once a crate is published, it's impossible to know if those leaked
70-
credentials have been copied, so taking swift action is crucial.
64+
When addressing copyright, licensing, or personal data issues with a published
65+
crate, simply yanking it may not suffice. In such cases, contact the maintainers
66+
of the registry you used. For crates.io, refer to their [policies] and contact
67+
68+
69+
If credentials have been leaked, the recommended course of action is to revoke
70+
them immediately. Once a crate has been published, it is impossible to determine
71+
if the leaked credentials have been copied. Yanking the crate only prevents new
72+
users from downloading it, but cannot stop those who have already downloaded it
73+
from keeping or even spreading the leaked credentials.
7174

7275
[RustSec]: https://rustsec.org/
7376
[policies]: https://crates.io/policies

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

+12-9
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,18 @@ DESCRIPTION
6666
compatible version, to reduce the probability of preventing dependent
6767
crates from compiling.
6868

69-
To address copyright, licensing, or personal data issues with your
70-
published crate, contact the maintainers of the registry you used. For
71-
crates.io, refer to their policies <https://crates.io/policies> and
72-
contact them at <[email protected]>.
73-
74-
If your credentials have been leaked, the recommended process is to
75-
revoke them immediately. Once a crate is published, it’s impossible to
76-
know if those leaked credentials have been copied, so taking swift
77-
action is crucial.
69+
When addressing copyright, licensing, or personal data issues with a
70+
published crate, simply yanking it may not suffice. In such cases,
71+
contact the maintainers of the registry you used. For crates.io, refer
72+
to their policies <https://crates.io/policies> and contact them at
73+
74+
75+
If credentials have been leaked, the recommended course of action is to
76+
revoke them immediately. Once a crate has been published, it is
77+
impossible to determine if the leaked credentials have been copied.
78+
Yanking the crate only prevents new users from downloading it, but
79+
cannot stop those who have already downloaded it from keeping or even
80+
spreading the leaked credentials.
7881

7982
OPTIONS
8083
Yank Options

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

+10-7
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,16 @@ A common workflow is to yank a crate having already published a semver
6161
compatible version, to reduce the probability of preventing dependent
6262
crates from compiling.
6363

64-
To address copyright, licensing, or personal data issues with your published
65-
crate, contact the maintainers of the registry you used. For crates.io, refer
66-
to their [policies] and contact them at <[email protected]>.
67-
68-
If your credentials have been leaked, the recommended process is to revoke them
69-
immediately. Once a crate is published, it's impossible to know if those leaked
70-
credentials have been copied, so taking swift action is crucial.
64+
When addressing copyright, licensing, or personal data issues with a published
65+
crate, simply yanking it may not suffice. In such cases, contact the maintainers
66+
of the registry you used. For crates.io, refer to their [policies] and contact
67+
68+
69+
If credentials have been leaked, the recommended course of action is to revoke
70+
them immediately. Once a crate has been published, it is impossible to determine
71+
if the leaked credentials have been copied. Yanking the crate only prevents new
72+
users from downloading it, but cannot stop those who have already downloaded it
73+
from keeping or even spreading the leaked credentials.
7174

7275
[RustSec]: https://rustsec.org/
7376
[policies]: https://crates.io/policies

src/etc/man/cargo-yank.1

+10-7
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,16 @@ A common workflow is to yank a crate having already published a semver
9292
compatible version, to reduce the probability of preventing dependent
9393
crates from compiling.
9494
.sp
95-
To address copyright, licensing, or personal data issues with your published
96-
crate, contact the maintainers of the registry you used. For crates.io, refer
97-
to their \fIpolicies\fR <https://crates.io/policies> and contact them at <[email protected]>\&.
98-
.sp
99-
If your credentials have been leaked, the recommended process is to revoke them
100-
immediately. Once a crate is published, it\[cq]s impossible to know if those leaked
101-
credentials have been copied, so taking swift action is crucial.
95+
When addressing copyright, licensing, or personal data issues with a published
96+
crate, simply yanking it may not suffice. In such cases, contact the maintainers
97+
of the registry you used. For crates.io, refer to their \fIpolicies\fR <https://crates.io/policies> and contact
98+
them at <[email protected]>\&.
99+
.sp
100+
If credentials have been leaked, the recommended course of action is to revoke
101+
them immediately. Once a crate has been published, it is impossible to determine
102+
if the leaked credentials have been copied. Yanking the crate only prevents new
103+
users from downloading it, but cannot stop those who have already downloaded it
104+
from keeping or even spreading the leaked credentials.
102105
.SH "OPTIONS"
103106
.SS "Yank Options"
104107
.sp

0 commit comments

Comments
 (0)