Skip to content

Commit a717196

Browse files
committed
Improve documentation and add [future-incompat-report] config section
1 parent 365cae3 commit a717196

File tree

5 files changed

+25
-0
lines changed

5 files changed

+25
-0
lines changed

src/doc/man/cargo-report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,6 @@ Only display a report for the specified package
3737
cargo report future-incompat --package my-dep:0.0.1
3838

3939
## SEE ALSO
40+
[Future incompat report](../reference/future-incompat-report.html)
41+
4042
{{man "cargo" 1}}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,8 @@ EXAMPLES
2727
cargo report future-incompat --package my-dep:0.0.1
2828

2929
SEE ALSO
30+
Future incompat report
31+
<https://doc.rust-lang.org/cargo/reference/future-incompat-report.html>
32+
3033
cargo(1)
3134

src/doc/src/commands/cargo-report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,6 @@ Displays a report of the given _type_ - currently, only `future-incompat` is sup
3838
cargo report future-incompat --package my-dep:0.0.1
3939

4040
## SEE ALSO
41+
[Future incompat report](../reference/future-incompat-report.html)
42+
4143
[cargo(1)](cargo.html)

src/doc/src/reference/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ ENV_VAR_NAME_2 = { value = "value", force = true }
8787
# Value is relative to .cargo directory containing `config.toml`, make absolute
8888
ENV_VAR_NAME_3 = { value = "relative/path", relative = true }
8989

90+
[future-incompat-report]
91+
frequency = 'always' # when to display a notification about a future incompat report
92+
9093
[cargo-new]
9194
vcs = "none" # VCS to use ('git', 'hg', 'pijul', 'fossil', 'none')
9295

@@ -1058,3 +1061,16 @@ Sets the width for progress bar.
10581061
[revision]: https://git-scm.com/docs/gitrevisions
10591062
[registries]: registries.md
10601063
[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

src/etc/man/cargo-report.1

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,6 @@ cargo report future\-incompat \-\-package my\-dep:0.0.1
4343
.RE
4444
.RE
4545
.SH "SEE ALSO"
46+
\fIFuture incompat report\fR <https://doc.rust\-lang.org/cargo/reference/future\-incompat\-report.html>
47+
.sp
4648
\fBcargo\fR(1)

0 commit comments

Comments
 (0)