Skip to content

Commit 8eb8acb

Browse files
committed
Auto merge of #12832 - weihanglo:cargo-login, r=ehuss
doc(cargo-login): mention args after `--` in manpage
2 parents 87f4b1b + 536e0b7 commit 8eb8acb

File tree

4 files changed

+13
-4
lines changed

4 files changed

+13
-4
lines changed

src/doc/man/cargo-login.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ cargo-login --- Log in to a registry
66

77
## SYNOPSIS
88

9-
`cargo login` [_options_] [_token_] -- [_args_]
9+
`cargo login` [_options_] [_token_] [`--` _args_]
1010

1111
## DESCRIPTION
1212

1313
This command will run a credential provider to save a token so that commands
1414
that require authentication, such as {{man "cargo-publish" 1}}, will be
1515
automatically authenticated.
1616

17+
All the arguments following the two dashes (`--`) are passed to the credential provider.
18+
1719
For the default `cargo:token` credential provider, the token is saved
1820
in `$CARGO_HOME/credentials.toml`. `CARGO_HOME` defaults to `.cargo`
1921
in your home directory.

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@ NAME
44
cargo-login — Log in to a registry
55

66
SYNOPSIS
7-
cargo login [options] [token] – [args]
7+
cargo login [options] [token] [-- args]
88

99
DESCRIPTION
1010
This command will run a credential provider to save a token so that
1111
commands that require authentication, such as cargo-publish(1), will be
1212
automatically authenticated.
1313

14+
All the arguments following the two dashes (--) are passed to the
15+
credential provider.
16+
1417
For the default cargo:token credential provider, the token is saved in
1518
$CARGO_HOME/credentials.toml. CARGO_HOME defaults to .cargo in your home
1619
directory.

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ cargo-login --- Log in to a registry
66

77
## SYNOPSIS
88

9-
`cargo login` [_options_] [_token_] -- [_args_]
9+
`cargo login` [_options_] [_token_] [`--` _args_]
1010

1111
## DESCRIPTION
1212

1313
This command will run a credential provider to save a token so that commands
1414
that require authentication, such as [cargo-publish(1)](cargo-publish.html), will be
1515
automatically authenticated.
1616

17+
All the arguments following the two dashes (`--`) are passed to the credential provider.
18+
1719
For the default `cargo:token` credential provider, the token is saved
1820
in `$CARGO_HOME/credentials.toml`. `CARGO_HOME` defaults to `.cargo`
1921
in your home directory.

src/etc/man/cargo-login.1

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66
.SH "NAME"
77
cargo\-login \[em] Log in to a registry
88
.SH "SYNOPSIS"
9-
\fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] \[en] [\fIargs\fR]
9+
\fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] [\fB\-\-\fR \fIargs\fR]
1010
.SH "DESCRIPTION"
1111
This command will run a credential provider to save a token so that commands
1212
that require authentication, such as \fBcargo\-publish\fR(1), will be
1313
automatically authenticated.
1414
.sp
15+
All the arguments following the two dashes (\fB\-\-\fR) are passed to the credential provider.
16+
.sp
1517
For the default \fBcargo:token\fR credential provider, the token is saved
1618
in \fB$CARGO_HOME/credentials.toml\fR\&. \fBCARGO_HOME\fR defaults to \fB\&.cargo\fR
1719
in your home directory.

0 commit comments

Comments
 (0)