itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #12288 - weihanglo:doc-tweak, r=ehuss

Browse Source 
docs: some tweaks around `cargo test`
This commit is contained in:
bors 2023-06-19 00:18:43 +00:00
commit 1fa8da2619
5 changed files with 19 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/doc/man/cargo-test.md
View File

@ -59,8 +59,8 @@ on writing doc tests.
### Working directory of tests
The working directory of every test is set to the root directory of the package
the test belongs to.
The working directory when running each unit and integration test is set to the
root directory of the package the test belongs to.
Setting the working directory of tests to the package's root directory makes it
possible for tests to reliably access the package's files using relative paths,
regardless from where `cargo test` was executed from.
@ -69,7 +69,7 @@ For documentation tests, the working directory when invoking `rustdoc` is set to
the workspace root directory, and is also the directory `rustdoc` uses as the
compilation directory of each documentation test.
The working directory when running each documentation test is set to the root
directory of the package the test belongs to, and is controlled via `rustdoc`s
directory of the package the test belongs to, and is controlled via `rustdoc`'s
`--test-run-directory` option.
## OPTIONS

12
src/doc/man/generated_txt/cargo-test.txt
View File

@ -53,18 +53,18 @@ DESCRIPTION
information on writing doc tests.
Working directory of tests
The working directory of every test is set to the root directory of the
package the test belongs to. Setting the working directory of tests to
the package’s root directory makes it possible for tests to reliably
access the package’s files using relative paths, regardless from where
cargo test was executed from.
The working directory when running each unit and integration test is set
to the root directory of the package the test belongs to. Setting the
working directory of tests to the package’s root directory makes it
possible for tests to reliably access the package’s files using
relative paths, regardless from where cargo test was executed from.
For documentation tests, the working directory when invoking rustdoc is
set to the workspace root directory, and is also the directory rustdoc
uses as the compilation directory of each documentation test. The
working directory when running each documentation test is set to the
root directory of the package the test belongs to, and is controlled via
rustdocs --test-run-directory option.
rustdoc’s --test-run-directory option.
OPTIONS
Test Options

6
src/doc/src/commands/cargo-test.md
View File

@ -59,8 +59,8 @@ on writing doc tests.
### Working directory of tests
The working directory of every test is set to the root directory of the package
the test belongs to.
The working directory when running each unit and integration test is set to the
root directory of the package the test belongs to.
Setting the working directory of tests to the package's root directory makes it
possible for tests to reliably access the package's files using relative paths,
regardless from where `cargo test` was executed from.
@ -69,7 +69,7 @@ For documentation tests, the working directory when invoking `rustdoc` is set to
the workspace root directory, and is also the directory `rustdoc` uses as the
compilation directory of each documentation test.
The working directory when running each documentation test is set to the root
directory of the package the test belongs to, and is controlled via `rustdoc`s
directory of the package the test belongs to, and is controlled via `rustdoc`'s
`--test-run-directory` option.
## OPTIONS

18
src/doc/src/reference/unstable.md
View File

@ -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)

6
src/etc/man/cargo-test.1
View File

@ -54,8 +54,8 @@ and may change in the future; beware of depending on it.
See the \fIrustdoc book\fR <https://doc.rust\-lang.org/rustdoc/> for more information
on writing doc tests.
.SS "Working directory of tests"
The working directory of every test is set to the root directory of the package
the test belongs to.
The working directory when running each unit and integration test is set to the
root directory of the package the test belongs to.
Setting the working directory of tests to the package\[cq]s root directory makes it
possible for tests to reliably access the package\[cq]s files using relative paths,
regardless from where \fBcargo test\fR was executed from.
@ -64,7 +64,7 @@ For documentation tests, the working directory when invoking \fBrustdoc\fR is se
the workspace root directory, and is also the directory \fBrustdoc\fR uses as the
compilation directory of each documentation test.
The working directory when running each documentation test is set to the root
directory of the package the test belongs to, and is controlled via \fBrustdoc\fRs
directory of the package the test belongs to, and is controlled via \fBrustdoc\fR\[cq]s
\fB\-\-test\-run\-directory\fR option.
.SH "OPTIONS"
.SS "Test Options"