Skip to content

Commit 511422f

Browse files
weihangloweihanglo
committed
docs(report): manpage for cargo report future-incompat 
1 parent d198307 commit 511422f

13 files changed

+610
-35
lines changed

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# cargo-report-future-incompatibilities(1)
2+
{{~*set actionverb="Display a report for"}}
3+
4+
## NAME
5+
6+
cargo-report-future-incompatibilities --- Reports any crates which will eventually stop compiling
7+
8+
## SYNOPSIS
9+
10+
`cargo report future-incompatibilities` [_options_]
11+
12+
## DESCRIPTION
13+
14+
Displays a report of future-incompatible warnings that were emitted during
15+
previous builds.
16+
These are warnings for changes that may become hard errors in the future,
17+
causing dependencies to stop building in a future version of rustc.
18+
19+
For more, see the chapter on [Future incompat report](../reference/future-incompat-report.html).
20+
21+
## OPTIONS
22+
23+
{{#options}}
24+
25+
{{#option "`--id` _id_" }}
26+
Show the report with the specified Cargo-generated id.
27+
If not specified, shows the most recent report.
28+
{{/option}}
29+
30+
{{/options}}
31+
32+
{{> section-options-package }}
33+
34+
### Display Options
35+
36+
{{#options}}
37+
{{> options-display }}
38+
{{/options}}
39+
40+
### Manifest Options
41+
42+
{{#options}}
43+
{{> options-locked }}
44+
{{/options}}
45+
46+
{{> section-options-common }}
47+
48+
{{> section-environment }}
49+
50+
{{> section-exit-status }}
51+
52+
## EXAMPLES
53+
54+
1. Display the latest future-incompat report:
55+
56+
cargo report future-incompat
57+
58+
2. Display the latest future-incompat report for a specific package:
59+
60+
cargo report future-incompat --package [email protected]
61+
62+
## SEE ALSO
63+
64+
{{man "cargo" 1}}, {{man "cargo-report" 1}}, {{man "cargo-build" 1}}

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,10 @@ Displays a report of the given _type_ --- currently, only `future-incompat` is s
3434

3535
## EXAMPLES
3636

37-
1. Display the latest future-incompat report:
37+
1. Display the available kinds of reports:
3838

39-
cargo report future-incompat
40-
41-
2. Display the latest future-incompat report for a specific package:
42-
43-
cargo report future-incompat --package [email protected]
39+
cargo report --help
4440

4541
## SEE ALSO
4642

47-
{{man "cargo" 1}}, [Future incompat report](../reference/future-incompat-report.html)
43+
{{man "cargo" 1}}, {{man "cargo-report-future-incompatibilities" 1}}

‎src/doc/man/cargo.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ available at <https://rust-lang.org>.
128128
{{man "cargo-report" 1}}\
129129
&nbsp;&nbsp;&nbsp;&nbsp;Generate and display various kinds of reports.
130130

131+
{{man "cargo-report-future-incompatibilities" 1}}\
132+
&nbsp;&nbsp;&nbsp;&nbsp;Reports any crates which will eventually stop compiling.
133+
131134
### General Commands
132135

133136
{{man "cargo-help" 1}}\

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

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
CARGO-REPORT-FUTURE-INCOMPATIBILITIES(1)
2+
3+
NAME
4+
cargo-report-future-incompatibilities — Reports any crates which will
5+
eventually stop compiling
6+
7+
SYNOPSIS
8+
cargo report future-incompatibilities [options]
9+
10+
DESCRIPTION
11+
Displays a report of future-incompatible warnings that were emitted
12+
during previous builds. These are warnings for changes that may become
13+
hard errors in the future, causing dependencies to stop building in a
14+
future version of rustc.
15+
16+
For more, see the chapter on Future incompat report
17+
<https://doc.rust-lang.org/cargo/reference/future-incompat-report.html>.
18+
19+
OPTIONS
20+
--id id
21+
Show the report with the specified Cargo-generated id. If not
22+
specified, shows the most recent report.
23+
24+
Package Selection
25+
By default, the package in the current working directory is selected.
26+
The -p flag can be used to choose a different package in a workspace.
27+
28+
-p spec, --package spec
29+
The package to display a report for. See cargo-pkgid(1) for the SPEC
30+
format.
31+
32+
Display Options
33+
-v, --verbose
34+
Use verbose output. May be specified twice for “very verbose”
35+
output which includes extra output such as dependency warnings and
36+
build script output. May also be specified with the term.verbose
37+
config value
38+
<https://doc.rust-lang.org/cargo/reference/config.html>.
39+
40+
-q, --quiet
41+
Do not print cargo log messages. May also be specified with the
42+
term.quiet config value
43+
<https://doc.rust-lang.org/cargo/reference/config.html>.
44+
45+
--color when
46+
Control when colored output is used. Valid values:
47+
48+
o auto (default): Automatically detect if color support is
49+
available on the terminal.
50+
51+
o always: Always display colors.
52+
53+
o never: Never display colors.
54+
55+
May also be specified with the term.color config value
56+
<https://doc.rust-lang.org/cargo/reference/config.html>.
57+
58+
Manifest Options
59+
--locked
60+
Asserts that the exact same dependencies and versions are used as
61+
when the existing Cargo.lock file was originally generated. Cargo
62+
will exit with an error when either of the following scenarios
63+
arises:
64+
65+
o The lock file is missing.
66+
67+
o Cargo attempted to change the lock file due to a different
68+
dependency resolution.
69+
70+
It may be used in environments where deterministic builds are
71+
desired, such as in CI pipelines.
72+
73+
--offline
74+
Prevents Cargo from accessing the network for any reason. Without
75+
this flag, Cargo will stop with an error if it needs to access the
76+
network and the network is not available. With this flag, Cargo will
77+
attempt to proceed without the network if possible.
78+
79+
Beware that this may result in different dependency resolution than
80+
online mode. Cargo will restrict itself to crates that are
81+
downloaded locally, even if there might be a newer version as
82+
indicated in the local copy of the index. See the cargo-fetch(1)
83+
command to download dependencies before going offline.
84+
85+
May also be specified with the net.offline config value
86+
<https://doc.rust-lang.org/cargo/reference/config.html>.
87+
88+
--frozen
89+
Equivalent to specifying both --locked and --offline.
90+
91+
Common Options
92+
+toolchain
93+
If Cargo has been installed with rustup, and the first argument to
94+
cargo begins with +, it will be interpreted as a rustup toolchain
95+
name (such as +stable or +nightly). See the rustup documentation
96+
<https://rust-lang.github.io/rustup/overrides.html> for more
97+
information about how toolchain overrides work.
98+
99+
--config KEY=VALUE or PATH
100+
Overrides a Cargo configuration value. The argument should be in
101+
TOML syntax of KEY=VALUE, or provided as a path to an extra
102+
configuration file. This flag may be specified multiple times. See
103+
the command-line overrides section
104+
<https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides>
105+
for more information.
106+
107+
-C PATH
108+
Changes the current working directory before executing any specified
109+
operations. This affects things like where cargo looks by default
110+
for the project manifest (Cargo.toml), as well as the directories
111+
searched for discovering .cargo/config.toml, for example. This
112+
option must appear before the command name, for example cargo -C
113+
path/to/my-project build.
114+
115+
This option is only available on the nightly channel
116+
<https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and
117+
requires the -Z unstable-options flag to enable (see #10098
118+
<https://github.com/rust-lang/cargo/issues/10098>).
119+
120+
-h, --help
121+
Prints help information.
122+
123+
-Z flag
124+
Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
125+
details.
126+
127+
ENVIRONMENT
128+
See the reference
129+
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>
130+
for details on environment variables that Cargo reads.
131+
132+
EXIT STATUS
133+
o 0: Cargo succeeded.
134+
135+
o 101: Cargo failed to complete.
136+
137+
EXAMPLES
138+
1. Display the latest future-incompat report:
139+
140+
cargo report future-incompat
141+
142+
2. Display the latest future-incompat report for a specific package:
143+
144+
cargo report future-incompat --package [email protected]
145+
146+
SEE ALSO
147+
cargo(1), cargo-report(1), cargo-build(1)
148+

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

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,10 @@ EXIT STATUS
117117
o 101: Cargo failed to complete.
118118

119119
EXAMPLES
120-
1. Display the latest future-incompat report:
120+
1. Display the available kinds of reports:
121121

122-
cargo report future-incompat
123-
124-
2. Display the latest future-incompat report for a specific package:
125-
126-
cargo report future-incompat --package [email protected]
122+
cargo report --help
127123

128124
SEE ALSO
129-
cargo(1), Future incompat report
130-
<https://doc.rust-lang.org/cargo/reference/future-incompat-report.html>
125+
cargo(1), cargo-report-future-incompatibilities(1)
131126

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ COMMANDS
121121
cargo-report(1)
122122
    Generate and display various kinds of reports.
123123

124+
cargo-report-future-incompatibilities(1)
125+
    Reports any crates which will eventually stop compiling.
126+
124127
General Commands
125128
cargo-help(1)
126129
    Display help information about Cargo.

‎src/doc/src/SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
* [cargo yank](commands/cargo-yank.md)
9797
* [Report Commands](commands/report-commands.md)
9898
* [cargo report](commands/cargo-report.md)
99+
* [cargo report future-incompatibilities](commands/cargo-report-future-incompatibilities.md)
99100
* [Deprecated and Removed](commands/deprecated-and-removed.md)
100101

101102
* [FAQ](faq.md)

0 commit comments

Comments
 (0)