Skip to content

doc(cargo-login): mention args after -- in manpage #12832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2023
Merged

doc(cargo-login): mention args after -- in manpage #12832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/doc/man/cargo-login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@ cargo-login --- Log in to a registry

## SYNOPSIS

`cargo login` [_options_] [_token_] -- [_args_]
`cargo login` [_options_] [_token_] [`--` _args_]

## DESCRIPTION

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

All the arguments following the two dashes (`--`) are passed to the credential provider.

For the default `cargo:token` credential provider, the token is saved
in `$CARGO_HOME/credentials.toml`. `CARGO_HOME` defaults to `.cargo`
in your home directory.
Expand Down
5 changes: 4 additions & 1 deletion src/doc/man/generated_txt/cargo-login.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ NAME
cargo-login — Log in to a registry

SYNOPSIS
cargo login [options] [token] – [args]
cargo login [options] [token] [-- args]

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

All the arguments following the two dashes (--) are passed to the
credential provider.

For the default cargo:token credential provider, the token is saved in
$CARGO_HOME/credentials.toml. CARGO_HOME defaults to .cargo in your home
directory.
Expand Down
4 changes: 3 additions & 1 deletion src/doc/src/commands/cargo-login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@ cargo-login --- Log in to a registry

## SYNOPSIS

`cargo login` [_options_] [_token_] -- [_args_]
`cargo login` [_options_] [_token_] [`--` _args_]

## DESCRIPTION

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

All the arguments following the two dashes (`--`) are passed to the credential provider.

For the default `cargo:token` credential provider, the token is saved
in `$CARGO_HOME/credentials.toml`. `CARGO_HOME` defaults to `.cargo`
in your home directory.
Expand Down
4 changes: 3 additions & 1 deletion src/etc/man/cargo-login.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
.SH "NAME"
cargo\-login \[em] Log in to a registry
.SH "SYNOPSIS"
\fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] \[en] [\fIargs\fR]
\fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] [\fB\-\-\fR \fIargs\fR]
.SH "DESCRIPTION"
This command will run a credential provider to save a token so that commands
that require authentication, such as \fBcargo\-publish\fR(1), will be
automatically authenticated.
.sp
All the arguments following the two dashes (\fB\-\-\fR) are passed to the credential provider.
.sp
For the default \fBcargo:token\fR credential provider, the token is saved
in \fB$CARGO_HOME/credentials.toml\fR\&. \fBCARGO_HOME\fR defaults to \fB\&.cargo\fR
in your home directory.
Expand Down