Skip to content

Commit 8c7c35e

Browse files
Aaron1011Aaron1011
committed
Update docs
1 parent c2332dc commit 8c7c35e

26 files changed

+281
-30
lines changed

‎src/doc/man/cargo-build.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ See <https://github.com/rust-lang/cargo/issues/5579> for more information.
8989

9090
{{#options}}
9191
{{> options-jobs }}
92+
{{> options-future-incompat }}
9293
{{/options}}
9394

9495
{{> section-environment }}

‎src/doc/man/cargo-check.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ they have `required-features` that are missing.
7474

7575
{{#options}}
7676
{{> options-jobs }}
77+
{{> options-future-incompat }}
7778
{{/options}}
7879

7980
{{> section-environment }}

‎src/doc/man/cargo-report.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# cargo-report(1)
2+
3+
## NAME
4+
5+
cargo-report - Generate and display various kinds of reports
6+
7+
## SYNOPSIS
8+
9+
`cargo report` _type_ [_options_]
10+
11+
### DESCRIPTION
12+
13+
Displays a report of the given _type_ - currently, only `future-incompat` is supported
14+
15+
## OPTIONS
16+
17+
{{#options}}
18+
19+
{{#option "`--id` _id_" }}
20+
Show the report with the specified Cargo-generated id
21+
{{/option}}
22+
23+
{{#option "`-p` _spec_..." "`--package` _spec_..." }}
24+
Only display a report for the specified package
25+
{{/option}}
26+
27+
{{/options}}
28+
29+
## EXAMPLES
30+
31+
1. Display the latest future-incompat report:
32+
33+
cargo report future-incompat
34+
35+
2. Display the latest future-incompat report for a specific package:
36+
37+
cargo report future-incompat --package my-dep:0.0.1
38+
39+
## SEE ALSO
40+
{{man "cargo" 1}}

‎src/doc/man/cargo-rustc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ See the [the reference](../reference/profiles.html) for more details on profiles
100100

101101
{{#options}}
102102
{{> options-jobs }}
103+
{{> options-future-incompat }}
103104
{{/options}}
104105

105106
{{> section-environment }}

‎src/doc/man/cargo-test.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ includes an option to control the number of threads used:
153153
{{#options}}
154154

155155
{{> options-jobs }}
156+
{{> options-future-incompat }}
156157

157158
{{/options}}
158159

‎src/doc/man/generated_txt/cargo-build.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,12 @@ OPTIONS
287287
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
288288
the number of CPUs.
289289

290+
--future-incompat-report
291+
Displays a future-incompat report for any future-incompatible
292+
warnings produced during execution of this command
293+
294+
See cargo-report(1)
295+
290296
ENVIRONMENT
291297
See the reference
292298
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

‎src/doc/man/generated_txt/cargo-check.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,12 @@ OPTIONS
281281
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
282282
the number of CPUs.
283283

284+
--future-incompat-report
285+
Displays a future-incompat report for any future-incompatible
286+
warnings produced during execution of this command
287+
288+
See cargo-report(1)
289+
284290
ENVIRONMENT
285291
See the reference
286292
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

‎src/doc/man/generated_txt/cargo-report.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
CARGO-REPORT(1)
2+
3+
NAME
4+
cargo-report - Generate and display various kinds of reports
5+
6+
SYNOPSIS
7+
cargo report type [options]
8+
9+
DESCRIPTION
10+
Displays a report of the given type - currently, only future-incompat is
11+
supported
12+
13+
OPTIONS
14+
--id id
15+
Show the report with the specified Cargo-generated id
16+
17+
-p spec..., --package spec...
18+
Only display a report for the specified package
19+
20+
EXAMPLES
21+
1. Display the latest future-incompat report:
22+
23+
cargo report future-incompat
24+
25+
2. Display the latest future-incompat report for a specific package:
26+
27+
cargo report future-incompat --package my-dep:0.0.1
28+
29+
SEE ALSO
30+
cargo(1)
31+

‎src/doc/man/generated_txt/cargo-rustc.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,12 @@ OPTIONS
276276
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
277277
the number of CPUs.
278278

279+
--future-incompat-report
280+
Displays a future-incompat report for any future-incompatible
281+
warnings produced during execution of this command
282+
283+
See cargo-report(1)
284+
279285
ENVIRONMENT
280286
See the reference
281287
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

‎src/doc/man/generated_txt/cargo-test.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,12 @@ OPTIONS
357357
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
358358
the number of CPUs.
359359

360+
--future-incompat-report
361+
Displays a future-incompat report for any future-incompatible
362+
warnings produced during execution of this command
363+
364+
See cargo-report(1)
365+
360366
ENVIRONMENT
361367
See the reference
362368
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

0 commit comments

Comments
 (0)