mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add missing rustdoc tests explanations

This commit is contained in:
Guillaume Gomez 2022-03-09 14:36:37 +01:00 committed by Noah Lev
parent 133100ead7
commit 3782d52fab
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/tests/compiletest.md
View File

@ -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`, - `run-make-fulldeps` — `run-make` tests which require a linkable build of `rustc`,
or the rust demangler or the rust demangler
- [`run-pass-valgrind`](#valgrind-tests) — tests run with Valgrind - [`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 - `rustdoc` — tests for rustdoc, making sure that the generated files
contain the expected documentation. contain the expected documentation.
- `rustdoc-gui` — TODO - `rustdoc-gui` — tests for rustdoc's GUI using a web browser.
- `rustdoc-js` — TODO - `rustdoc-js` — tests to ensure the rustdoc search is working as expected.
- `rustdoc-js-std` — TODO - `rustdoc-js-std` — tests to ensure the rustdoc search is working as expected
- `rustdoc-json` — TODO (run specifically on the std docs).
- `rustdoc-ui` — TODO - `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/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 [`src/tools/compiletest/src/common.rs`]: https://github.com/rust-lang/rust/tree/master/src/tools/compiletest/src/common.rs

2
src/tests/intro.md
View File

@ -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 src/tools/linkchecker`
> Example: `./x.py test linkchecker`
This requires building all of the documentation, which might take a while. This requires building all of the documentation, which might take a while.
### Dist check ### Dist check