From: Eric Huss <eric@huss.org>
Date: Wed, 13 Jul 2022 00:38:19 +0000 (-0700)
Subject: Small tweaks to the future-incompat docs.
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=32cbfded5b22ac8e918b6144357721e3713cfbd6;p=cargo.git

Small tweaks to the future-incompat docs.
---

diff --git a/src/doc/src/reference/future-incompat-report.md b/src/doc/src/reference/future-incompat-report.md
index 703536ed3..b72f11757 100644
--- a/src/doc/src/reference/future-incompat-report.md
+++ b/src/doc/src/reference/future-incompat-report.md
@@ -1,24 +1,37 @@
 ### Future incompat report
 
-Cargo checks for  future-incompatible warnings in all dependencies. These are warnings for
+Cargo checks for future-incompatible warnings in all dependencies. These are warnings for
 changes that may become hard errors in the future, causing the dependency to
 stop building in a future version of rustc. If any warnings are found, a small
 notice is displayed indicating that the warnings were found, and provides
 instructions on how to display a full report.
 
+For example, you may see something like this at the end of a build:
+
+```text
+warning: the following packages contain code that will be rejected by a future
+         version of Rust: rental v0.5.5
+note: to see what the problems were, use the option `--future-incompat-report`,
+      or run `cargo report future-incompatibilities --id 1`
+```
+
 A full report can be displayed with the `cargo report future-incompatibilities
 --id ID` command, or by running the build again with
 the `--future-incompat-report` flag. The developer should then update their
 dependencies to a version where the issue is fixed, or work with the
 developers of the dependencies to help resolve the issue.
 
-This feature can be configured through a `[future-incompat-report]`
-section in `.cargo/config`. Currently, the supported options are:
+## Configuration
 
-```
+This feature can be configured through a [`[future-incompat-report]`][config]
+section in `.cargo/config.toml`. Currently, the supported options are:
+
+```toml
 [future-incompat-report]
-frequency = FREQUENCY
+frequency = "always"
 ```
 
-The supported values for `FREQUENCY` are `always` and `never`, which control
+The supported values for the frequency are `"always"` and `"never"`, which control
 whether or not a message is printed out at the end of `cargo build` / `cargo check`.
+
+[config]: config.md#future-incompat-report