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

docs: add more links to pkgid spec chapter #13298

Merged
merged 1 commit into from
Jan 15, 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
4 changes: 3 additions & 1 deletion src/doc/man/cargo-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,4 +388,6 @@ reproduction of the information within `Cargo.toml`.
cargo metadata --format-version=1

## SEE ALSO
{{man "cargo" 1}}
{{man "cargo" 1}}, {{man "cargo-pkgid" 1}}, [Package ID Specifications]

[Package ID Specifications]: ../reference/pkgid-spec.html
6 changes: 5 additions & 1 deletion src/doc/man/cargo-pkgid.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ _url_`#`_version_ | `https://github.com/rust-lang/cargo#0.33.0`
_url_`#`_name_ | `https://github.com/rust-lang/crates.io-index#bitflags`
_url_`#`_name_`@`_version_ | `https://github.com/rust-lang/cargo#[email protected]`

The specification grammar can be found in chapter [Package ID Specifications].

## OPTIONS

### Package Selection
Expand Down Expand Up @@ -86,4 +88,6 @@ Get the package ID for the given package instead of the current package.
cargo pkgid file:///path/to/local/package#foo

## SEE ALSO
{{man "cargo" 1}}, {{man "cargo-generate-lockfile" 1}}, {{man "cargo-metadata" 1}}
{{man "cargo" 1}}, {{man "cargo-generate-lockfile" 1}}, {{man "cargo-metadata" 1}}, [Package ID Specifications]

[Package ID Specifications]: ../reference/pkgid-spec.html
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -476,5 +476,6 @@ EXAMPLES
cargo metadata --format-version=1

SEE ALSO
cargo(1)
cargo(1), cargo-pkgid(1), Package ID Specifications
<https://doc.rust-lang.org/cargo/reference/pkgid-spec.html>

8 changes: 7 additions & 1 deletion src/doc/man/generated_txt/cargo-pkgid.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ DESCRIPTION
| url#name@version | https://github.com/rust-lang/cargo#[email protected] |
+-----------------+--------------------------------------------------+

The specification grammar can be found in chapter Package ID
Specifications
<https://doc.rust-lang.org/cargo/reference/pkgid-spec.html>.

OPTIONS
Package Selection
-p spec, --package spec
Expand Down Expand Up @@ -166,5 +170,7 @@ EXAMPLES
cargo pkgid file:///path/to/local/package#foo

SEE ALSO
cargo(1), cargo-generate-lockfile(1), cargo-metadata(1)
cargo(1), cargo-generate-lockfile(1), cargo-metadata(1), Package ID
Specifications
<https://doc.rust-lang.org/cargo/reference/pkgid-spec.html>

4 changes: 3 additions & 1 deletion src/doc/src/commands/cargo-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -507,4 +507,6 @@ details on environment variables that Cargo reads.
cargo metadata --format-version=1

## SEE ALSO
[cargo(1)](cargo.html)
[cargo(1)](cargo.html), [cargo-pkgid(1)](cargo-pkgid.html), [Package ID Specifications]

[Package ID Specifications]: ../reference/pkgid-spec.html
6 changes: 5 additions & 1 deletion src/doc/src/commands/cargo-pkgid.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ _url_`#`_version_ | `https://github.com/rust-lang/cargo#0.33.0`
_url_`#`_name_ | `https://github.com/rust-lang/crates.io-index#bitflags`
_url_`#`_name_`@`_version_ | `https://github.com/rust-lang/cargo#[email protected]`

The specification grammar can be found in chapter [Package ID Specifications].

## OPTIONS

### Package Selection
Expand Down Expand Up @@ -181,4 +183,6 @@ details on environment variables that Cargo reads.
cargo pkgid file:///path/to/local/package#foo

## SEE ALSO
[cargo(1)](cargo.html), [cargo-generate-lockfile(1)](cargo-generate-lockfile.html), [cargo-metadata(1)](cargo-metadata.html)
[cargo(1)](cargo.html), [cargo-generate-lockfile(1)](cargo-generate-lockfile.html), [cargo-metadata(1)](cargo-metadata.html), [Package ID Specifications]

[Package ID Specifications]: ../reference/pkgid-spec.html
2 changes: 1 addition & 1 deletion src/etc/man/cargo-metadata.1
Original file line number Diff line number Diff line change
Expand Up @@ -523,4 +523,4 @@ cargo metadata \-\-format\-version=1
.RE
.RE
.SH "SEE ALSO"
\fBcargo\fR(1)
\fBcargo\fR(1), \fBcargo\-pkgid\fR(1), \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>
4 changes: 3 additions & 1 deletion src/etc/man/cargo-pkgid.1
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ T}:T{
T}
.TE
.sp
.sp
The specification grammar can be found in chapter \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>\&.
.SH "OPTIONS"
.SS "Package Selection"
.sp
Expand Down Expand Up @@ -240,4 +242,4 @@ cargo pkgid file:///path/to/local/package#foo
.RE
.RE
.SH "SEE ALSO"
\fBcargo\fR(1), \fBcargo\-generate\-lockfile\fR(1), \fBcargo\-metadata\fR(1)
\fBcargo\fR(1), \fBcargo\-generate\-lockfile\fR(1), \fBcargo\-metadata\fR(1), \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>