Skip to content

Commit 263b169

Browse files
borsbors
committed
Auto merge of #10165 - Aaron1011:stabilize-future-incompat, r=ehuss
Stabilize future-incompat-report Depends on rust-lang/rust#91535
2 parents cf474a5 + 673b15d commit 263b169

35 files changed

+371
-112
lines changed

‎src/bin/cargo/commands/report.rs

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
use crate::command_prelude::*;
2-
use anyhow::anyhow;
32
use cargo::core::compiler::future_incompat::{OnDiskReports, REPORT_PREAMBLE};
43
use cargo::drop_println;
54

@@ -24,9 +23,6 @@ pub fn cli() -> App {
2423
}
2524

2625
pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
27-
if !config.nightly_features_allowed {
28-
return Err(anyhow!("`cargo report` can only be used on the nightly channel").into());
29-
}
3026
match args.subcommand() {
3127
("future-incompatibilities", Some(args)) => report_future_incompatibilies(config, args),
3228
(cmd, _) => panic!("unexpected command `{}`", cmd),

‎src/cargo/core/compiler/build_context/target_info.rs

+12
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ pub struct TargetInfo {
4747
pub rustdocflags: Vec<String>,
4848
/// Whether or not rustc supports the `-Csplit-debuginfo` flag.
4949
pub supports_split_debuginfo: bool,
50+
/// Whether or not rustc supports the `--json future-incompat` flag.
51+
pub supports_json_future_incompat: bool,
5052
}
5153

5254
/// Kind of each file generated by a Unit, part of `FileType`.
@@ -179,6 +181,15 @@ impl TargetInfo {
179181
)
180182
.is_ok();
181183

184+
let supports_json_future_incompat = rustc
185+
.cached_output(
186+
process
187+
.clone()
188+
.args(&["--error-format", "json", "--json", "future-incompat"]),
189+
extra_fingerprint,
190+
)
191+
.is_ok();
192+
182193
process.arg("--print=sysroot");
183194
process.arg("--print=cfg");
184195

@@ -253,6 +264,7 @@ impl TargetInfo {
253264
)?,
254265
cfg,
255266
supports_split_debuginfo,
267+
supports_json_future_incompat,
256268
})
257269
}
258270

‎src/cargo/core/compiler/future_incompat.rs

-3
Original file line numberDiff line numberDiff line change
@@ -321,9 +321,6 @@ pub fn save_and_display_report(
321321
bcx: &BuildContext<'_, '_>,
322322
per_package_future_incompat_reports: &[FutureIncompatReportPackage],
323323
) {
324-
if !bcx.config.cli_unstable().future_incompat_report {
325-
return;
326-
}
327324
let should_display_message = match bcx.config.future_incompat_config() {
328325
Ok(config) => config.should_display_message(),
329326
Err(e) => {

‎src/cargo/core/compiler/mod.rs

+18-7
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ fn rustdoc(cx: &mut Context<'_, '_>, unit: &Unit) -> CargoResult<Work> {
641641
rustdoc.arg("--cfg").arg(&format!("feature=\"{}\"", feat));
642642
}
643643

644-
add_error_format_and_color(cx, &mut rustdoc, false);
644+
add_error_format_and_color(cx, &mut rustdoc, unit, false);
645645
add_allow_features(cx, &mut rustdoc);
646646

647647
if let Some(args) = cx.bcx.extra_args_for(unit) {
@@ -790,14 +790,29 @@ fn add_allow_features(cx: &Context<'_, '_>, cmd: &mut ProcessBuilder) {
790790
/// intercepting messages like rmeta artifacts, etc. rustc includes a
791791
/// "rendered" field in the JSON message with the message properly formatted,
792792
/// which Cargo will extract and display to the user.
793-
fn add_error_format_and_color(cx: &Context<'_, '_>, cmd: &mut ProcessBuilder, pipelined: bool) {
793+
fn add_error_format_and_color(
794+
cx: &Context<'_, '_>,
795+
cmd: &mut ProcessBuilder,
796+
unit: &Unit,
797+
pipelined: bool,
798+
) {
794799
cmd.arg("--error-format=json");
795800
let mut json = String::from("--json=diagnostic-rendered-ansi");
796801
if pipelined {
797802
// Pipelining needs to know when rmeta files are finished. Tell rustc
798803
// to emit a message that cargo will intercept.
799804
json.push_str(",artifacts");
800805
}
806+
if cx
807+
.bcx
808+
.target_data
809+
.info(unit.kind)
810+
.supports_json_future_incompat
811+
{
812+
// Emit a future-incompat report (when supported by rustc), so we can report
813+
// future-incompat dependencies to the user
814+
json.push_str(",future-incompat");
815+
}
801816

802817
match cx.bcx.build_config.message_format {
803818
MessageFormat::Short | MessageFormat::Json { short: true, .. } => {
@@ -858,7 +873,7 @@ fn build_base_args(
858873
edition.cmd_edition_arg(cmd);
859874

860875
add_path_args(bcx.ws, unit, cmd);
861-
add_error_format_and_color(cx, cmd, cx.rmeta_required(unit));
876+
add_error_format_and_color(cx, cmd, unit, cx.rmeta_required(unit));
862877
add_allow_features(cx, cmd);
863878

864879
let mut contains_dy_lib = false;
@@ -1022,10 +1037,6 @@ fn build_base_args(
10221037
.env("RUSTC_BOOTSTRAP", "1");
10231038
}
10241039

1025-
if bcx.config.cli_unstable().future_incompat_report {
1026-
cmd.arg("-Z").arg("emit-future-incompat-report");
1027-
}
1028-
10291040
// Add `CARGO_BIN_` environment variables for building tests.
10301041
if unit.target.is_test() || unit.target.is_bench() {
10311042
for bin_target in unit

‎src/cargo/core/features.rs

+6-2
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,6 @@ unstable_cli_options!(
637637
doctest_in_workspace: bool = ("Compile doctests with paths relative to the workspace root"),
638638
doctest_xcompile: bool = ("Compile and run doctests for non-host target using runner config"),
639639
dual_proc_macros: bool = ("Build proc-macros for both the host and the target"),
640-
future_incompat_report: bool = ("Enable creation of a future-incompat report for all dependencies"),
641640
features: Option<Vec<String>> = (HIDDEN),
642641
jobserver_per_rustc: bool = (HIDDEN),
643642
minimal_versions: bool = ("Resolve minimal dependency versions instead of maximum"),
@@ -705,6 +704,9 @@ const STABILIZED_NAMED_PROFILES: &str = "The named-profiles feature is now alway
705704
See https://doc.rust-lang.org/nightly/cargo/reference/profiles.html#custom-profiles \
706705
for more information";
707706

707+
const STABILIZED_FUTURE_INCOMPAT_REPORT: &str =
708+
"The future-incompat-report feature is now always enabled.";
709+
708710
fn deserialize_build_std<'de, D>(deserializer: D) -> Result<Option<Vec<String>>, D::Error>
709711
where
710712
D: serde::Deserializer<'de>,
@@ -894,7 +896,9 @@ impl CliUnstable {
894896
"extra-link-arg" => stabilized_warn(k, "1.56", STABILIZED_EXTRA_LINK_ARG),
895897
"configurable-env" => stabilized_warn(k, "1.56", STABILIZED_CONFIGURABLE_ENV),
896898
"patch-in-config" => stabilized_warn(k, "1.56", STABILIZED_PATCH_IN_CONFIG),
897-
"future-incompat-report" => self.future_incompat_report = parse_empty(k, v)?,
899+
"future-incompat-report" => {
900+
stabilized_warn(k, "1.59.0", STABILIZED_FUTURE_INCOMPAT_REPORT)
901+
}
898902
_ => bail!("unknown `-Z` flag specified: {}", k),
899903
}
900904

‎src/cargo/util/command_prelude.rs

+1-12
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ pub trait AppExt: Sized {
233233
fn arg_future_incompat_report(self) -> Self {
234234
self._arg(opt(
235235
"future-incompat-report",
236-
"Outputs a future incompatibility report at the end of the build (unstable)",
236+
"Outputs a future incompatibility report at the end of the build",
237237
))
238238
}
239239
}
@@ -512,17 +512,6 @@ pub trait ArgMatchesExt {
512512
.cli_unstable()
513513
.fail_if_stable_opt("--unit-graph", 8002)?;
514514
}
515-
if build_config.future_incompat_report {
516-
config
517-
.cli_unstable()
518-
.fail_if_stable_opt("--future-incompat-report", 9241)?;
519-
520-
if !config.cli_unstable().future_incompat_report {
521-
anyhow::bail!(
522-
"Usage of `--future-incompat-report` requires `-Z future-incompat-report`"
523-
)
524-
}
525-
}
526515

527516
let opts = CompileOptions {
528517
build_config,

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

+1
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ See <https://github.com/rust-lang/cargo/issues/5579> for more information.
8989

9090
{{#options}}
9191
{{> options-jobs }}
92+
{{> options-future-incompat }}
9293
{{/options}}
9394

9495
{{> section-environment }}

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

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ they have `required-features` that are missing.
7474

7575
{{#options}}
7676
{{> options-jobs }}
77+
{{> options-future-incompat }}
7778
{{/options}}
7879

7980
{{> section-environment }}

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

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# cargo-report(1)
2+
3+
## NAME
4+
5+
cargo-report - Generate and display various kinds of reports
6+
7+
## SYNOPSIS
8+
9+
`cargo report` _type_ [_options_]
10+
11+
### DESCRIPTION
12+
13+
Displays a report of the given _type_ - currently, only `future-incompat` is supported
14+
15+
## OPTIONS
16+
17+
{{#options}}
18+
19+
{{#option "`--id` _id_" }}
20+
Show the report with the specified Cargo-generated id
21+
{{/option}}
22+
23+
{{#option "`-p` _spec_..." "`--package` _spec_..." }}
24+
Only display a report for the specified package
25+
{{/option}}
26+
27+
{{/options}}
28+
29+
## EXAMPLES
30+
31+
1. Display the latest future-incompat report:
32+
33+
cargo report future-incompat
34+
35+
2. Display the latest future-incompat report for a specific package:
36+
37+
cargo report future-incompat --package my-dep:0.0.1
38+
39+
## SEE ALSO
40+
[Future incompat report](../reference/future-incompat-report.html)
41+
42+
{{man "cargo" 1}}

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

+1
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ See the [the reference](../reference/profiles.html) for more details on profiles
100100

101101
{{#options}}
102102
{{> options-jobs }}
103+
{{> options-future-incompat }}
103104
{{/options}}
104105

105106
{{> section-environment }}

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

+1
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ includes an option to control the number of threads used:
153153
{{#options}}
154154

155155
{{> options-jobs }}
156+
{{> options-future-incompat }}
156157

157158
{{/options}}
158159

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

+6
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,12 @@ OPTIONS
287287
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
288288
the number of CPUs.
289289

290+
--future-incompat-report
291+
Displays a future-incompat report for any future-incompatible
292+
warnings produced during execution of this command
293+
294+
See cargo-report(1)
295+
290296
ENVIRONMENT
291297
See the reference
292298
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

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

+6
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,12 @@ OPTIONS
281281
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
282282
the number of CPUs.
283283

284+
--future-incompat-report
285+
Displays a future-incompat report for any future-incompatible
286+
warnings produced during execution of this command
287+
288+
See cargo-report(1)
289+
284290
ENVIRONMENT
285291
See the reference
286292
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

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

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
CARGO-REPORT(1)
2+
3+
NAME
4+
cargo-report - Generate and display various kinds of reports
5+
6+
SYNOPSIS
7+
cargo report type [options]
8+
9+
DESCRIPTION
10+
Displays a report of the given type - currently, only future-incompat is
11+
supported
12+
13+
OPTIONS
14+
--id id
15+
Show the report with the specified Cargo-generated id
16+
17+
-p spec..., --package spec...
18+
Only display a report for the specified package
19+
20+
EXAMPLES
21+
1. Display the latest future-incompat report:
22+
23+
cargo report future-incompat
24+
25+
2. Display the latest future-incompat report for a specific package:
26+
27+
cargo report future-incompat --package my-dep:0.0.1
28+
29+
SEE ALSO
30+
Future incompat report
31+
<https://doc.rust-lang.org/cargo/reference/future-incompat-report.html>
32+
33+
cargo(1)
34+

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

+6
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,12 @@ OPTIONS
276276
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
277277
the number of CPUs.
278278

279+
--future-incompat-report
280+
Displays a future-incompat report for any future-incompatible
281+
warnings produced during execution of this command
282+
283+
See cargo-report(1)
284+
279285
ENVIRONMENT
280286
See the reference
281287
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

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

+6
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,12 @@ OPTIONS
357357
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
358358
the number of CPUs.
359359

360+
--future-incompat-report
361+
Displays a future-incompat report for any future-incompatible
362+
warnings produced during execution of this command
363+
364+
See cargo-report(1)
365+
360366
ENVIRONMENT
361367
See the reference
362368
<https://doc.rust-lang.org/cargo/reference/environment-variables.html>

‎src/doc/man/includes/options-future-incompat.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{#option "`--future-incompat-report`"}}
2+
Displays a future-incompat report for any future-incompatible warnings
3+
produced during execution of this command
4+
5+
See {{man "cargo-report" 1}}
6+
{{/option}}

‎src/doc/src/SUMMARY.md

+2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
* [Registries](reference/registries.md)
3939
* [Dependency Resolution](reference/resolver.md)
4040
* [SemVer Compatibility](reference/semver.md)
41+
* [Future incompat report](reference/future-incompat-report.md)
4142
* [Unstable Features](reference/unstable.md)
4243

4344
* [Cargo Commands](commands/index.md)
@@ -57,6 +58,7 @@
5758
* [cargo rustc](commands/cargo-rustc.md)
5859
* [cargo rustdoc](commands/cargo-rustdoc.md)
5960
* [cargo test](commands/cargo-test.md)
61+
* [cargo report](commands/cargo-report.md)
6062
* [Manifest Commands](commands/manifest-commands.md)
6163
* [cargo generate-lockfile](commands/cargo-generate-lockfile.md)
6264
* [cargo locate-project](commands/cargo-locate-project.md)

‎src/doc/src/commands/build-commands.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
* [cargo rustc](cargo-rustc.md)
1111
* [cargo rustdoc](cargo-rustdoc.md)
1212
* [cargo test](cargo-test.md)
13+
* [cargo report](cargo-report.md)

‎src/doc/src/commands/cargo-build.md

+6
Original file line numberDiff line numberDiff line change
@@ -355,6 +355,12 @@ for more information about how toolchain overrides work.</dd>
355355
the number of CPUs.</dd>
356356

357357

358+
<dt class="option-term" id="option-cargo-build---future-incompat-report"><a class="option-anchor" href="#option-cargo-build---future-incompat-report"></a><code>--future-incompat-report</code></dt>
359+
<dd class="option-desc">Displays a future-incompat report for any future-incompatible warnings
360+
produced during execution of this command</p>
361+
<p>See <a href="cargo-report.html">cargo-report(1)</a></dd>
362+
363+
358364
</dl>
359365

360366
## ENVIRONMENT

‎src/doc/src/commands/cargo-check.md

+6
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,12 @@ for more information about how toolchain overrides work.</dd>
346346
the number of CPUs.</dd>
347347

348348

349+
<dt class="option-term" id="option-cargo-check---future-incompat-report"><a class="option-anchor" href="#option-cargo-check---future-incompat-report"></a><code>--future-incompat-report</code></dt>
350+
<dd class="option-desc">Displays a future-incompat report for any future-incompatible warnings
351+
produced during execution of this command</p>
352+
<p>See <a href="cargo-report.html">cargo-report(1)</a></dd>
353+
354+
349355
</dl>
350356

351357
## ENVIRONMENT

0 commit comments

Comments
 (0)