Skip to content

Commit 7b8acb1

Browse files
committed
docs: add more links to pkgid spec chapter
1 parent d530b46 commit 7b8acb1

File tree

8 files changed

+29
-8
lines changed

8 files changed

+29
-8
lines changed

src/doc/man/cargo-metadata.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,4 +388,6 @@ reproduction of the information within `Cargo.toml`.
388388
cargo metadata --format-version=1
389389
390390
## SEE ALSO
391-
{{man "cargo" 1}}
391+
{{man "cargo" 1}}, {{man "cargo-pkgid" 1}}, [Package ID Specifications]
392+
393+
[Package ID Specifications]: ../reference/pkgid-spec.html

src/doc/man/cargo-pkgid.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ _url_`#`_version_ | `https://github.com/rust-lang/cargo#0.33.0`
3333
_url_`#`_name_ | `https://github.com/rust-lang/crates.io-index#bitflags`
3434
_url_`#`_name_`@`_version_ | `https://github.com/rust-lang/cargo#[email protected]`
3535

36+
The specification grammar can be found in chapter [Package ID Specifications].
37+
3638
## OPTIONS
3739

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

8890
## SEE ALSO
89-
{{man "cargo" 1}}, {{man "cargo-generate-lockfile" 1}}, {{man "cargo-metadata" 1}}
91+
{{man "cargo" 1}}, {{man "cargo-generate-lockfile" 1}}, {{man "cargo-metadata" 1}}, [Package ID Specifications]
92+
93+
[Package ID Specifications]: ../reference/pkgid-spec.html

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,5 +476,6 @@ EXAMPLES
476476
cargo metadata --format-version=1
477477

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

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ DESCRIPTION
3939
| url#name@version | https://github.com/rust-lang/cargo#[email protected] |
4040
+-----------------+--------------------------------------------------+
4141

42+
The specification grammar can be found in chapter Package ID
43+
Specifications
44+
<https://doc.rust-lang.org/cargo/reference/pkgid-spec.html>.
45+
4246
OPTIONS
4347
Package Selection
4448
-p spec, --package spec
@@ -166,5 +170,7 @@ EXAMPLES
166170
cargo pkgid file:///path/to/local/package#foo
167171

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

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,4 +507,6 @@ details on environment variables that Cargo reads.
507507
cargo metadata --format-version=1
508508

509509
## SEE ALSO
510-
[cargo(1)](cargo.html)
510+
[cargo(1)](cargo.html), [cargo-pkgid(1)](cargo-pkgid.html), [Package ID Specifications]
511+
512+
[Package ID Specifications]: ../reference/pkgid-spec.html

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ _url_`#`_version_ | `https://github.com/rust-lang/cargo#0.33.0`
3333
_url_`#`_name_ | `https://github.com/rust-lang/crates.io-index#bitflags`
3434
_url_`#`_name_`@`_version_ | `https://github.com/rust-lang/cargo#[email protected]`
3535

36+
The specification grammar can be found in chapter [Package ID Specifications].
37+
3638
## OPTIONS
3739

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

183185
## SEE ALSO
184-
[cargo(1)](cargo.html), [cargo-generate-lockfile(1)](cargo-generate-lockfile.html), [cargo-metadata(1)](cargo-metadata.html)
186+
[cargo(1)](cargo.html), [cargo-generate-lockfile(1)](cargo-generate-lockfile.html), [cargo-metadata(1)](cargo-metadata.html), [Package ID Specifications]
187+
188+
[Package ID Specifications]: ../reference/pkgid-spec.html

src/etc/man/cargo-metadata.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -523,4 +523,4 @@ cargo metadata \-\-format\-version=1
523523
.RE
524524
.RE
525525
.SH "SEE ALSO"
526-
\fBcargo\fR(1)
526+
\fBcargo\fR(1), \fBcargo\-pkgid\fR(1), \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>

src/etc/man/cargo-pkgid.1

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ T}:T{
6262
T}
6363
.TE
6464
.sp
65+
.sp
66+
The specification grammar can be found in chapter \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>\&.
6567
.SH "OPTIONS"
6668
.SS "Package Selection"
6769
.sp
@@ -240,4 +242,4 @@ cargo pkgid file:///path/to/local/package#foo
240242
.RE
241243
.RE
242244
.SH "SEE ALSO"
243-
\fBcargo\fR(1), \fBcargo\-generate\-lockfile\fR(1), \fBcargo\-metadata\fR(1)
245+
\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>

0 commit comments

Comments
 (0)