Skip to content

Commit 4fcf5ca

Browse files
committed
Adjust [future-incompat-report] docs
1 parent a717196 commit 4fcf5ca

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

src/doc/src/reference/config.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -507,6 +507,20 @@ TMPDIR = { value = "/home/tmp", force = true }
507507
OPENSSL_DIR = { value = "vendor/openssl", relative = true }
508508
```
509509

510+
### `[future-incompat-report]`
511+
512+
The `[future-incompat-report]` table controls setting for [future incompat reporting](future-incompat-report.md)
513+
514+
#### `future-incompat-report.frequency`
515+
* Type: string
516+
* Default: "always"
517+
* Environment: `CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY`
518+
519+
Controls how often we display a notification to the terminal when a future incompat report is available. Possible values:
520+
521+
* `always` (default): Always display a notification when a command (e.g. `cargo build`) produces a future incompat report
522+
* `never`: Never display a notification
523+
510524
#### `[http]`
511525

512526
The `[http]` table defines settings for HTTP behavior. This includes fetching
@@ -1061,16 +1075,3 @@ Sets the width for progress bar.
10611075
[revision]: https://git-scm.com/docs/gitrevisions
10621076
[registries]: registries.md
10631077
[crates.io]: https://crates.io/
1064-
1065-
### `[future-incompat-report]`
1066-
1067-
The `[future-incompat-report]` table controls setting for [future incompat reporting](../reference/future-incompat-report.html)
1068-
1069-
#### `future-incompat-report.frequency`
1070-
* Type: string
1071-
* Default: "always"
1072-
1073-
Controls how often we display a notification to the terminal when a future incompat report is available. Possible values:
1074-
1075-
* `always` (default): Always display a notification when a command (e.g. `cargo build`) produces a future incompat report
1076-
* `never`: Never display a notification

0 commit comments

Comments
 (0)