Skip to content

Commit 4b8d939

Browse files
GuillaumeGomezcamelid
authored andcommitted
Add missing rustdoc tests explanations
1 parent eb90c9c commit 4b8d939

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

src/tests/compiletest.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,15 @@ The following test suites are available, with links for more information:
5252
- `run-make-fulldeps``run-make` tests which require a linkable build of `rustc`,
5353
or the rust demangler
5454
- [`run-pass-valgrind`](#valgrind-tests) — tests run with Valgrind
55-
- Rustdoc tests:
55+
- [Rustdoc tests](../rustdoc.md#tests):
5656
- `rustdoc` — tests for rustdoc, making sure that the generated files
5757
contain the expected documentation.
58-
- `rustdoc-gui` — TODO
59-
- `rustdoc-js` — TODO
60-
- `rustdoc-js-std` — TODO
61-
- `rustdoc-json` — TODO
62-
- `rustdoc-ui` — TODO
58+
- `rustdoc-gui` — tests for rustdoc's GUI using a web browser.
59+
- `rustdoc-js` — tests to ensure the rustdoc search is working as expected.
60+
- `rustdoc-js-std` — tests to ensure the rustdoc search is working as expected
61+
(run specifically on the std docs).
62+
- `rustdoc-json` — tests on the JSON output of rustdoc.
63+
- `rustdoc-ui` — tests on the terminal output of rustdoc.
6364

6465
[`src/test`]: https://github.com/rust-lang/rust/blob/master/src/test
6566
[`src/tools/compiletest/src/common.rs`]: https://github.com/rust-lang/rust/tree/master/src/tools/compiletest/src/common.rs

src/tests/intro.md

+2
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ Links across all documentation is validated with a link checker tool.
101101

102102
> Example: `./x.py test src/tools/linkchecker`
103103
104+
> Example: `./x.py test linkchecker`
105+
104106
This requires building all of the documentation, which might take a while.
105107

106108
### Dist check

0 commit comments

Comments
 (0)