Skip to content

Commit ad8504a

Browse files
committed
adjust dev-guide for xtask doctest
1 parent c2ac774 commit ad8504a

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

dev-guide/src/tests.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
There are several different kinds of tests you can run (these are enforced in CI):
44

55
- [`cargo xtask test-all`](#all-tests) --- Runs all tests.
6-
- [`mdbook test`](#inline-tests) --- Tests the inline Rust code blocks.
6+
- [`cargo xtask doctest`](#inline-tests) --- Tests the inline Rust code blocks.
77
- [`cargo xtask linkcheck`](#linkcheck) --- Validates that Markdown links aren't broken.
88
- [`cargo xtask style-check`](#style-checks) --- Validates various style checks.
99
- [Code formatting](#code-formatting) --- Checks that all Rust tooling code is formatted.
@@ -22,11 +22,13 @@ We recommend running this as a last step before opening a PR. This runs most of
2222
## Inline tests
2323

2424
```sh
25-
mdbook test
25+
cargo xtask doctest
2626
```
2727

2828
This command runs all tests that are inline in the Markdown. Internally, this uses [`rustdoc`](https://doc.rust-lang.org/rustdoc/) to run the tests and supports all the same features. Any code block with the `rust` language will be compiled unless it is ignored. See [Examples] for more.
2929

30+
Previous versions of this guide suggested `mdbook test`, but this only works reliably if your default toolchain is nightly.
31+
3032
## Linkcheck
3133

3234
```sh

dev-guide/src/tooling/building.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ First, ensure that you have a recent copy of the nightly Rust compiler installed
1717

1818
```sh
1919
rustup toolchain install nightly
20-
rustup override set nightly
2120
```
2221

2322
Now, ensure you have `mdbook` installed, as this is needed to build the Reference:

0 commit comments

Comments
 (0)