diff options
| author | Guillaume Gomez <guillaume.gomez@huawei.com> | 2022-03-09 14:36:37 +0100 |
|---|---|---|
| committer | Noah Lev <camelidcamel@gmail.com> | 2022-03-09 12:45:59 -0800 |
| commit | 1916c191c311215ed2b3398c1dd0c2d2fe620d1a (patch) | |
| tree | be3959f3a2acd93df21b51659c61624b1c48dd0f /src/doc/rustc-dev-guide | |
| parent | 7a93737e8a752f688ccd840f67132385d938c1d6 (diff) | |
| download | rust-1916c191c311215ed2b3398c1dd0c2d2fe620d1a.tar.gz rust-1916c191c311215ed2b3398c1dd0c2d2fe620d1a.zip | |
Add missing rustdoc tests explanations
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/compiletest.md | 13 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/intro.md | 2 |
2 files changed, 9 insertions, 6 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/compiletest.md b/src/doc/rustc-dev-guide/src/tests/compiletest.md index 503b95f19f1..7e147c9ceb7 100644 --- a/src/doc/rustc-dev-guide/src/tests/compiletest.md +++ b/src/doc/rustc-dev-guide/src/tests/compiletest.md @@ -52,14 +52,15 @@ The following test suites are available, with links for more information: - `run-make-fulldeps` — `run-make` tests which require a linkable build of `rustc`, or the rust demangler - [`run-pass-valgrind`](#valgrind-tests) — tests run with Valgrind -- Rustdoc tests: +- [Rustdoc tests](../rustdoc.md#tests): - `rustdoc` — tests for rustdoc, making sure that the generated files contain the expected documentation. - - `rustdoc-gui` — TODO - - `rustdoc-js` — TODO - - `rustdoc-js-std` — TODO - - `rustdoc-json` — TODO - - `rustdoc-ui` — TODO + - `rustdoc-gui` — tests for rustdoc's GUI using a web browser. + - `rustdoc-js` — tests to ensure the rustdoc search is working as expected. + - `rustdoc-js-std` — tests to ensure the rustdoc search is working as expected + (run specifically on the std docs). + - `rustdoc-json` — tests on the JSON output of rustdoc. + - `rustdoc-ui` — tests on the terminal output of rustdoc. [`src/test`]: https://github.com/rust-lang/rust/blob/master/src/test [`src/tools/compiletest/src/common.rs`]: https://github.com/rust-lang/rust/tree/master/src/tools/compiletest/src/common.rs diff --git a/src/doc/rustc-dev-guide/src/tests/intro.md b/src/doc/rustc-dev-guide/src/tests/intro.md index 65facccbaad..92f6cb66426 100644 --- a/src/doc/rustc-dev-guide/src/tests/intro.md +++ b/src/doc/rustc-dev-guide/src/tests/intro.md @@ -101,6 +101,8 @@ Links across all documentation is validated with a link checker tool. > Example: `./x.py test src/tools/linkchecker` +> Example: `./x.py test linkchecker` + This requires building all of the documentation, which might take a while. ### Dist check |