Skip to content

Commit f838a00

Browse files
ebrotoebroto
committed
Stabilize RUSTC_WORKSPACE_WRAPPER
1 parent c68c622 commit f838a00

File tree

7 files changed

+41
-41
lines changed

7 files changed

+41
-41
lines changed

‎src/cargo/util/config/mod.rs

-4
Original file line numberDiff line numberDiff line change
@@ -327,10 +327,6 @@ impl Config {
327327
&self.build_config()?.rustc_workspace_wrapper,
328328
);
329329

330-
if !self.cli_unstable().unstable_options && rustc_workspace_wrapper.is_some() {
331-
bail!("Usage of `RUSTC_WORKSPACE_WRAPPER` requires `-Z unstable-options`")
332-
}
333-
334330
Rustc::new(
335331
self.get_tool("rustc", &self.build_config()?.rustc),
336332
wrapper,

‎src/doc/src/reference/config.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,18 @@ rr = "run --release"
5454
space_example = ["run", "--release", "--", "\"command list\""]
5555

5656
[build]
57-
jobs = 1 # number of parallel jobs, defaults to # of CPUs
58-
rustc = "rustc" # the rust compiler tool
59-
rustc-wrapper = "…" # run this wrapper instead of `rustc`
60-
rustdoc = "rustdoc" # the doc generator tool
61-
target = "triple" # build for the target triple (ignored by `cargo install`)
62-
target-dir = "target" # path of where to place all generated artifacts
63-
rustflags = ["…", "…"] # custom flags to pass to all compiler invocations
64-
rustdocflags = ["…", "…"] # custom flags to pass to rustdoc
65-
incremental = true # whether or not to enable incremental compilation
66-
dep-info-basedir = "…" # path for the base directory for targets in depfiles
67-
pipelining = true # rustc pipelining
57+
jobs = 1 # number of parallel jobs, defaults to # of CPUs
58+
rustc = "rustc" # the rust compiler tool
59+
rustc-wrapper = "…" # run this wrapper instead of `rustc`
60+
rustc-workspace-wrapper = "…" # run this wrapper instead of `rustc` for workspace members
61+
rustdoc = "rustdoc" # the doc generator tool
62+
target = "triple" # build for the target triple (ignored by `cargo install`)
63+
target-dir = "target" # path of where to place all generated artifacts
64+
rustflags = ["…", "…"] # custom flags to pass to all compiler invocations
65+
rustdocflags = ["…", "…"] # custom flags to pass to rustdoc
66+
incremental = true # whether or not to enable incremental compilation
67+
dep-info-basedir = "…" # path for the base directory for targets in depfiles
68+
pipelining = true # rustc pipelining
6869

6970
[cargo-new]
7071
name = "Your Name" # name to use in `authors` field
@@ -282,6 +283,15 @@ Sets the executable to use for `rustc`.
282283
Sets a wrapper to execute instead of `rustc`. The first argument passed to the
283284
wrapper is the path to the actual `rustc`.
284285

286+
##### `build.rustc-workspace-wrapper`
287+
* Type: string (program path)
288+
* Default: none
289+
* Environment: `CARGO_BUILD_RUSTC_WORKSPACE_WRAPPER` or `RUSTC_WORKSPACE_WRAPPER`
290+
291+
Sets a wrapper to execute instead of `rustc`, for workspace members only.
292+
The first argument passed to the wrapper is the path to the actual `rustc`.
293+
It affects the filename hash so that artifacts produced by the wrapper are cached separately.
294+
285295
##### `build.rustdoc`
286296
* Type: string (program path)
287297
* Default: "rustdoc"

‎src/doc/src/reference/environment-variables.md

+8
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ system:
2424
specified wrapper instead, passing as its commandline arguments the rustc
2525
invocation, with the first argument being `rustc`. Useful to set up a build
2626
cache tool such as `sccache`. See [`build.rustc-wrapper`] to set via config.
27+
* `RUSTC_WORKSPACE_WRAPPER` — Instead of simply running `rustc`, Cargo will
28+
execute this specified wrapper instead for workspace members only, passing
29+
as its commandline arguments the rustc invocation, with the first argument
30+
being `rustc`. It affects the filename hash so that artifacts produced by
31+
the wrapper are cached separately. See [`build.rustc-workspace-wrapper`]
32+
to set via config.
2733
* `RUSTDOC` — Instead of running `rustdoc`, Cargo will execute this specified
2834
`rustdoc` instance instead. See [`build.rustdoc`] to set via config.
2935
* `RUSTDOCFLAGS` — A space-separated list of custom flags to pass to all `rustdoc`
@@ -63,6 +69,7 @@ supported environment variables are:
6369
* `CARGO_BUILD_JOBS` — Number of parallel jobs, see [`build.jobs`].
6470
* `CARGO_BUILD_RUSTC` — The `rustc` executable, see [`build.rustc`].
6571
* `CARGO_BUILD_RUSTC_WRAPPER` — The `rustc` wrapper, see [`build.rustc-wrapper`].
72+
* `CARGO_BUILD_RUSTC_WORKSPACE_WRAPPER` — The `rustc` wrapper for workspace members only, see [`build.rustc-workspace-wrapper`].
6673
* `CARGO_BUILD_RUSTDOC` — The `rustdoc` executable, see [`build.rustdoc`].
6774
* `CARGO_BUILD_TARGET` — The default target platform, see [`build.target`].
6875
* `CARGO_BUILD_TARGET_DIR` — The default output directory, see [`build.target-dir`].
@@ -121,6 +128,7 @@ supported environment variables are:
121128
[`build.jobs`]: config.md#buildjobs
122129
[`build.rustc`]: config.md#buildrustc
123130
[`build.rustc-wrapper`]: config.md#buildrustc-wrapper
131+
[`build.rustc-workspace-wrapper`]: config.md#buildrustc-workspace-wrapper
124132
[`build.rustdoc`]: config.md#buildrustdoc
125133
[`build.target`]: config.md#buildtarget
126134
[`build.target-dir`]: config.md#buildtarget-dir

‎tests/testsuite/build.rs

+3-6
Original file line numberDiff line numberDiff line change
@@ -4023,9 +4023,8 @@ fn rustc_wrapper_from_path() {
40234023
#[cfg(not(windows))]
40244024
fn rustc_workspace_wrapper() {
40254025
let p = project().file("src/lib.rs", "").build();
4026-
p.cargo("build -v -Zunstable-options")
4026+
p.cargo("build -v")
40274027
.env("RUSTC_WORKSPACE_WRAPPER", "/usr/bin/env")
4028-
.masquerade_as_nightly_cargo()
40294028
.with_stderr_contains("[RUNNING] `/usr/bin/env rustc --crate-name foo [..]")
40304029
.run();
40314030
}
@@ -4034,9 +4033,8 @@ fn rustc_workspace_wrapper() {
40344033
#[cfg(not(windows))]
40354034
fn rustc_workspace_wrapper_relative() {
40364035
let p = project().file("src/lib.rs", "").build();
4037-
p.cargo("build -v -Zunstable-options")
4036+
p.cargo("build -v")
40384037
.env("RUSTC_WORKSPACE_WRAPPER", "./sccache")
4039-
.masquerade_as_nightly_cargo()
40404038
.with_status(101)
40414039
.with_stderr_contains("[..]/foo/./sccache rustc[..]")
40424040
.run();
@@ -4046,9 +4044,8 @@ fn rustc_workspace_wrapper_relative() {
40464044
#[cfg(not(windows))]
40474045
fn rustc_workspace_wrapper_from_path() {
40484046
let p = project().file("src/lib.rs", "").build();
4049-
p.cargo("build -v -Zunstable-options")
4047+
p.cargo("build -v")
40504048
.env("RUSTC_WORKSPACE_WRAPPER", "wannabe_sccache")
4051-
.masquerade_as_nightly_cargo()
40524049
.with_status(101)
40534050
.with_stderr_contains("[..]`wannabe_sccache rustc [..]")
40544051
.run();

‎tests/testsuite/cache_messages.rs

+2-4
Original file line numberDiff line numberDiff line change
@@ -469,9 +469,8 @@ fn rustc_workspace_wrapper() {
469469
)
470470
.build();
471471

472-
p.cargo("check -Zunstable-options -v")
472+
p.cargo("check -v")
473473
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
474-
.masquerade_as_nightly_cargo()
475474
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name foo src/lib.rs [..]")
476475
.run();
477476

@@ -488,9 +487,8 @@ fn rustc_workspace_wrapper() {
488487
.run();
489488

490489
// Again, reading from the cache.
491-
p.cargo("check -Zunstable-options -v")
490+
p.cargo("check -v")
492491
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
493-
.masquerade_as_nightly_cargo()
494492
.with_stderr_contains("[FRESH] foo [..]")
495493
.with_stdout_does_not_contain("WRAPPER CALLED: rustc --crate-name foo src/lib.rs [..]")
496494
.run();

‎tests/testsuite/check.rs

+5-12
Original file line numberDiff line numberDiff line change
@@ -861,10 +861,7 @@ fn does_not_use_empty_rustc_wrapper() {
861861
#[cargo_test]
862862
fn does_not_use_empty_rustc_workspace_wrapper() {
863863
let p = project().file("src/lib.rs", "").build();
864-
p.cargo("check -Zunstable-options")
865-
.masquerade_as_nightly_cargo()
866-
.env("RUSTC_WORKSPACE_WRAPPER", "")
867-
.run();
864+
p.cargo("check").env("RUSTC_WORKSPACE_WRAPPER", "").run();
868865
}
869866

870867
#[cargo_test]
@@ -905,9 +902,8 @@ fn rustc_workspace_wrapper_affects_all_workspace_members() {
905902
.file("baz/src/lib.rs", "pub fn baz() {}")
906903
.build();
907904

908-
p.cargo("check -Zunstable-options")
905+
p.cargo("check")
909906
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
910-
.masquerade_as_nightly_cargo()
911907
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name bar [..]")
912908
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name baz [..]")
913909
.run();
@@ -939,9 +935,8 @@ fn rustc_workspace_wrapper_includes_path_deps() {
939935
.file("baz/src/lib.rs", "pub fn baz() {}")
940936
.build();
941937

942-
p.cargo("check --workspace -Zunstable-options")
938+
p.cargo("check --workspace")
943939
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
944-
.masquerade_as_nightly_cargo()
945940
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name foo [..]")
946941
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name bar [..]")
947942
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name baz [..]")
@@ -965,9 +960,8 @@ fn rustc_workspace_wrapper_respects_primary_units() {
965960
.file("baz/src/lib.rs", "pub fn baz() {}")
966961
.build();
967962

968-
p.cargo("check -p bar -Zunstable-options")
963+
p.cargo("check -p bar")
969964
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
970-
.masquerade_as_nightly_cargo()
971965
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name bar [..]")
972966
.with_stdout_does_not_contain("WRAPPER CALLED: rustc --crate-name baz [..]")
973967
.run();
@@ -999,9 +993,8 @@ fn rustc_workspace_wrapper_excludes_published_deps() {
999993

1000994
Package::new("baz", "1.0.0").publish();
1001995

1002-
p.cargo("check --workspace -v -Zunstable-options")
996+
p.cargo("check --workspace -v")
1003997
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
1004-
.masquerade_as_nightly_cargo()
1005998
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name foo [..]")
1006999
.with_stderr_contains("WRAPPER CALLED: rustc --crate-name bar [..]")
10071000
.with_stderr_contains("[CHECKING] baz [..]")

‎tests/testsuite/fix.rs

+2-4
Original file line numberDiff line numberDiff line change
@@ -1096,9 +1096,8 @@ fn does_not_crash_with_rustc_workspace_wrapper() {
10961096
.file("src/lib.rs", "")
10971097
.build();
10981098

1099-
p.cargo("fix --allow-no-vcs --verbose -Zunstable-options")
1099+
p.cargo("fix --allow-no-vcs --verbose")
11001100
.env("RUSTC_WORKSPACE_WRAPPER", "/usr/bin/env")
1101-
.masquerade_as_nightly_cargo()
11021101
.run();
11031102
}
11041103

@@ -1117,9 +1116,8 @@ fn uses_workspace_wrapper_and_primary_wrapper_override() {
11171116
.file("src/lib.rs", "")
11181117
.build();
11191118

1120-
p.cargo("fix --allow-no-vcs --verbose -Zunstable-options")
1119+
p.cargo("fix --allow-no-vcs --verbose")
11211120
.env("RUSTC_WORKSPACE_WRAPPER", paths::echo_wrapper())
1122-
.masquerade_as_nightly_cargo()
11231121
.with_stderr_contains("WRAPPER CALLED: rustc src/lib.rs --crate-name foo [..]")
11241122
.run();
11251123
}

0 commit comments

Comments
 (0)