Skip to content

Commit dda0d65

Browse files
committed
Elaborate a little on future-incompat unstable docs.
1 parent fac5243 commit dda0d65

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

src/doc/src/reference/unstable.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1150,9 +1150,18 @@ The 2021 edition will set the default [resolver version] to "2".
11501150
* RFC: [#2834](https://github.com/rust-lang/rfcs/blob/master/text/2834-cargo-report-future-incompat.md)
11511151
* rustc Tracking Issue: [#71249](https://github.com/rust-lang/rust/issues/71249)
11521152

1153-
The `-Z future-incompat-report` flag enables the creation of a future-incompat report
1154-
for all dependencies. This makes users aware if any of their crate's dependencies
1155-
might stop compiling with a future version of Rust.
1153+
The `-Z future-incompat-report` flag causes Cargo to check for
1154+
future-incompatible warnings in all dependencies. These are warnings for
1155+
changes that may become hard errors in the future, causing the dependency to
1156+
stop building in a future version of rustc. If any warnings are found, a small
1157+
notice is displayed indicating that the warnings were found, and provides
1158+
instructions on how to display a full report.
1159+
1160+
A full report can be displayed with the `cargo report future-incompatibilities
1161+
-Z future-incompat-report --id ID` command, or by running the build again with
1162+
the `--future-incompat-report` flag. The developer should then update their
1163+
dependencies to a version where the issue is fixed, or work with the
1164+
developers of the dependencies to help resolve the issue.
11561165

11571166
### configurable-env
11581167
* Original Pull Request: [#9175](https://github.com/rust-lang/cargo/pull/9175)

0 commit comments

Comments
 (0)