Skip to content

Commit a25acdb

Browse files
committed
Auto merge of #6604 - dwijnand:owner-add-invites, r=ehuss
Document that owner --add now just invites Fixes #4599
2 parents 2458180 + 5970385 commit a25acdb

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

src/bin/cargo/commands/owner.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pub fn cli() -> App {
66
subcommand("owner")
77
.about("Manage the owners of a crate on the registry")
88
.arg(Arg::with_name("crate"))
9-
.arg(multi_opt("add", "LOGIN", "Name of a user or team to add as an owner").short("a"))
9+
.arg(multi_opt("add", "LOGIN", "Name of a user or team to invite as an owner").short("a"))
1010
.arg(
1111
multi_opt(
1212
"remove",

src/doc/man/cargo-owner.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ information about owners and publishing.
3434

3535
*-a*::
3636
*--add* _LOGIN_...::
37-
Add the given user or team as an owner.
37+
Invite the given user or team as an owner.
3838

3939
*-r*::
4040
*--remove* _LOGIN_...::
@@ -68,7 +68,7 @@ include::section-exit-status.adoc[]
6868

6969
cargo owner --list foo
7070

71-
. Add an owner to a package:
71+
. Invite an owner to a package:
7272

7373
cargo owner --add username foo
7474

src/doc/man/generated/cargo-owner.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h3 id="cargo_owner_owner_options">Owner Options</h3>
4444
<dt class="hdlist1"><strong>-a</strong></dt>
4545
<dt class="hdlist1"><strong>--add</strong> <em>LOGIN</em>&#8230;&#8203;</dt>
4646
<dd>
47-
<p>Add the given user or team as an owner.</p>
47+
<p>Invite the given user or team as an owner.</p>
4848
</dd>
4949
<dt class="hdlist1"><strong>-r</strong></dt>
5050
<dt class="hdlist1"><strong>--remove</strong> <em>LOGIN</em>&#8230;&#8203;</dt>
@@ -176,7 +176,7 @@ <h2 id="cargo_owner_examples">EXAMPLES</h2>
176176
</div>
177177
</li>
178178
<li>
179-
<p>Add an owner to a package:</p>
179+
<p>Invite an owner to a package:</p>
180180
<div class="literalblock">
181181
<div class="content">
182182
<pre>cargo owner --add username foo</pre>

src/doc/src/reference/publishing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -151,21 +151,21 @@ $ cargo owner --remove github:rust-lang:owners
151151

152152
The owner IDs given to these commands must be GitHub user names or GitHub teams.
153153

154-
If a user name is given to `--add`, that user becomes a “named” owner, with
154+
If a user name is given to `--add`, that user is invited as a “named” owner, with
155155
full rights to the crate. In addition to being able to publish or yank versions
156156
of the crate, they have the ability to add or remove owners, *including* the
157157
owner that made *them* an owner. Needless to say, you shouldn’t make people you
158158
don’t fully trust into a named owner. In order to become a named owner, a user
159159
must have logged into [crates.io] previously.
160160

161-
If a team name is given to `--add`, that team becomes a “team” owner, with
161+
If a team name is given to `--add`, that team is invited as a “team” owner, with
162162
restricted right to the crate. While they have permission to publish or yank
163163
versions of the crate, they *do not* have the ability to add or remove owners.
164164
In addition to being more convenient for managing groups of owners, teams are
165165
just a bit more secure against owners becoming malicious.
166166

167167
The syntax for teams is currently `github:org:team` (see examples above).
168-
In order to add a team as an owner one must be a member of that team. No
168+
In order to invite a team as an owner one must be a member of that team. No
169169
such restriction applies to removing a team as an owner.
170170

171171
### GitHub permissions

src/etc/man/cargo-owner.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ information about owners and publishing.
5757
.sp
5858
\fB\-a\fP, \fB\-\-add\fP \fILOGIN\fP...
5959
.RS 4
60-
Add the given user or team as an owner.
60+
Invite the given user or team as an owner.
6161
.RE
6262
.sp
6363
\fB\-r\fP, \fB\-\-remove\fP \fILOGIN\fP...
@@ -199,7 +199,7 @@ cargo owner \-\-list foo
199199
. sp -1
200200
. IP " 2." 4.2
201201
.\}
202-
Add an owner to a package:
202+
Invite an owner to a package:
203203
.sp
204204
.if n .RS 4
205205
.nf

0 commit comments

Comments
 (0)