From 6ae954ff1e5979ee6f6e113e219be351ae4cad22 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Sat, 17 Jun 2023 21:48:46 +0100 Subject: [PATCH] docs(unstable): remove tracking for `-Zdoctest-in-workspace` --- src/doc/src/reference/unstable.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md index 49d3e007ef4f..afb2f7cbd612 100644 --- a/src/doc/src/reference/unstable.md +++ b/src/doc/src/reference/unstable.md @@ -1185,24 +1185,6 @@ cargo +nightly -Zunstable-options config get build.rustflags If no config value is included, it will display all config values. See the `--help` output for more options available. -### `doctest-in-workspace` - -* Tracking Issue: [#9427](https://github.com/rust-lang/cargo/issues/9427) - -The `-Z doctest-in-workspace` flag changes the behavior of the current working -directory used when running doctests. Historically, Cargo has run `rustdoc ---test` relative to the root of the package, with paths relative from that -root. However, this is inconsistent with how `rustc` and `rustdoc` are -normally run in a workspace, where they are run relative to the workspace -root. This inconsistency causes problems in various ways, such as when passing -RUSTDOCFLAGS with relative paths, or dealing with diagnostic output. - -The `-Z doctest-in-workspace` flag causes cargo to switch to running `rustdoc` -from the root of the workspace. It also passes the `--test-run-directory` to -`rustdoc` so that when *running* the tests, they are run from the root of the -package. This preserves backwards compatibility and is consistent with how -normal unittests are run. - ### rustc `--print` * Tracking Issue: [#9357](https://github.com/rust-lang/cargo/issues/9357) @@ -1799,4 +1781,4 @@ The [`cargo logout`] command has been stabilized in the 1.70 release. The `-Z doctest-in-workspace` option for `cargo test` has been stabilized and enabled by default in the 1.72 release. See the [`cargo test` documentation](../commands/cargo-test.md#working-directory-of-tests) -for more information about the working directory for compiling and running tests. \ No newline at end of file +for more information about the working directory for compiling and running tests.