Skip to content
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.

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

fix: Remove default registry reference in info cmd docs #14880

Merged
merged 1 commit into from
Dec 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo_util_schemas::core::PackageIdSpec;

pub fn cli() -> Command {
Command::new("info")
.about("Display information about a package in the registry")
.about("Display information about a package")
.arg(
Arg::new("package")
.required(true)
Expand Down
6 changes: 3 additions & 3 deletions src/doc/man/cargo-info.md
Rustin170506 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## NAME

cargo-info --- Display information about a package in the registry. Default registry is crates.io
cargo-info --- Display information about a package.

## SYNOPSIS

`cargo info` [_options_] _spec_

## DESCRIPTION

This command displays information about a package in the registry. It fetches data from the package's Cargo.toml file
This command displays information about a package. It fetches data from the package's Cargo.toml file
and presents it in a human-readable format.

## OPTIONS
Expand Down Expand Up @@ -60,7 +60,7 @@ selected based on the Minimum Supported Rust Version (MSRV).
cargo info [email protected]
3. Inspect the `serde` package form the local registry:

cargo info serde --registry my-registry
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it’s appropriate to include this change in the same commit. I’m fine with removing it or moving it to a separate commit if needed.

cargo info serde --registry my-registry

## SEE ALSO

Expand Down
11 changes: 5 additions & 6 deletions src/doc/man/generated_txt/cargo-info.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
CARGO-INFO(1)

NAME
cargo-info — Display information about a package in the registry.
Default registry is crates.io
cargo-info — Display information about a package.

SYNOPSIS
cargo info [options] spec

DESCRIPTION
This command displays information about a package in the registry. It
fetches data from the package’s Cargo.toml file and presents it in a
human-readable format.
This command displays information about a package. It fetches data from
the package’s Cargo.toml file and presents it in a human-readable
format.

OPTIONS
Info Options
Expand Down Expand Up @@ -149,7 +148,7 @@ EXAMPLES

3. Inspect the serde package form the local registry:

cargo info serde --registry my-registry
cargo info serde --registry my-registry

SEE ALSO
cargo(1), cargo-search(1)
Expand Down
6 changes: 3 additions & 3 deletions src/doc/src/commands/cargo-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## NAME

cargo-info --- Display information about a package in the registry. Default registry is crates.io
cargo-info --- Display information about a package.

## SYNOPSIS

`cargo info` [_options_] _spec_

## DESCRIPTION

This command displays information about a package in the registry. It fetches data from the package's Cargo.toml file
This command displays information about a package. It fetches data from the package's Cargo.toml file
and presents it in a human-readable format.

## OPTIONS
Expand Down Expand Up @@ -161,7 +161,7 @@ details on environment variables that Cargo reads.
cargo info [email protected]
3. Inspect the `serde` package form the local registry:

cargo info serde --registry my-registry
cargo info serde --registry my-registry

## SEE ALSO

Expand Down
6 changes: 3 additions & 3 deletions src/etc/man/cargo-info.1
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
.ad l
.ss \n[.ss] 0
.SH "NAME"
cargo\-info \[em] Display information about a package in the registry. Default registry is crates.io
cargo\-info \[em] Display information about a package.
.SH "SYNOPSIS"
\fBcargo info\fR [\fIoptions\fR] \fIspec\fR
.SH "DESCRIPTION"
This command displays information about a package in the registry. It fetches data from the package\[cq]s Cargo.toml file
This command displays information about a package. It fetches data from the package\[cq]s Cargo.toml file
and presents it in a human\-readable format.
.SH "OPTIONS"
.SS "Info Options"
Expand Down Expand Up @@ -193,7 +193,7 @@ details on environment variables that Cargo reads.
.sp
.RS 4
.nf
cargo info serde \-\-registry my\-registry
cargo info serde \-\-registry my\-registry
.fi
.RE
.RE
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/cargo_info/help/stdout.term.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.