user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update rustc-dev-guide about tests/rustdoc renamed into tests/rustdoc-html

Browse source
This commit is contained in:
Guillaume Gomez 2026-01-03 16:06:28 +01:00
parent a928f3352d
commit 8256623ab4
5 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/doc/rustc-dev-guide/src/SUMMARY.md
View file

@ -100,7 +100,7 @@
- [Parallel compilation](./parallel-rustc.md)
- [Rustdoc internals](./rustdoc-internals.md)
- [Search](./rustdoc-internals/search.md)
- [The `rustdoc` test suite](./rustdoc-internals/rustdoc-test-suite.md)
- [The `rustdoc-html` test suite](./rustdoc-internals/rustdoc-html-test-suite.md)
- [The `rustdoc-gui` test suite](./rustdoc-internals/rustdoc-gui-test-suite.md)
- [The `rustdoc-json` test suite](./rustdoc-internals/rustdoc-json-test-suite.md)
- [GPU offload internals](./offload/internals.md)

4
src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md → src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-html-test-suite.md
View file

@ -1,6 +1,6 @@
# The `rustdoc` test suite
# The `rustdoc-html` test suite
This page is about the test suite named `rustdoc` used to test the HTML output of `rustdoc`.
This page is about the test suite named `rustdoc-html` used to test the HTML output of `rustdoc`.
For other rustdoc-specific test suites, see [Rustdoc test suites].
Each test file in this test suite is simply a Rust source file `file.rs` sprinkled with

2
src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-json-test-suite.md
View file

@ -24,7 +24,7 @@ Also, talk about how it works
## jsondocck
[jsondocck] processes directives given in comments, to assert that the values in the output are expected.
It's a lot like [htmldocck](./rustdoc-test-suite.md) in that way.
It's a lot like [htmldocck](./rustdoc-html-test-suite.md) in that way.
It uses [JSONPath] as a query language, which takes a path, and returns a *list* of values that that path is said to match to.

4
src/doc/rustc-dev-guide/src/tests/compiletest.md
View file

@ -82,7 +82,7 @@ The following test suites are available, with links for more information:
| Test suite | Purpose |
|--------------------------------------|--------------------------------------------------------------------------|
| [`rustdoc`][rustdoc-html-tests] | Check HTML output of `rustdoc` |
| [`rustdoc-html`][rustdoc-html-tests] | Check HTML output of `rustdoc` |
| [`rustdoc-gui`][rustdoc-gui-tests] | Check `rustdoc`'s GUI using a web browser |
| [`rustdoc-js`][rustdoc-js-tests] | Check `rustdoc`'s search engine and index |
| [`rustdoc-js-std`][rustdoc-js-tests] | Check `rustdoc`'s search engine and index on the std library docs |
@ -94,7 +94,7 @@ These tests ensure that certain lints that are emitted as part of executing rust
are also run when executing rustc.
Run-make tests pertaining to rustdoc are typically named `run-make/rustdoc-*/`.
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-test-suite.md
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-html-test-suite.md
[rustdoc-gui-tests]: ../rustdoc-internals/rustdoc-gui-test-suite.md
[rustdoc-js-tests]: ../rustdoc-internals/search.md#testing-the-search-engine
[rustdoc-json-tests]: ../rustdoc-internals/rustdoc-json-test-suite.md

4
src/doc/rustc-dev-guide/src/tests/directives.md
View file

@ -308,12 +308,12 @@ Asked in
#### Test-suite-specific directives
The test suites [`rustdoc`][rustdoc-html-tests], [`rustdoc-js`/`rustdoc-js-std`][rustdoc-js-tests]
The test suites [`rustdoc-html`][rustdoc-html-tests], [`rustdoc-js`/`rustdoc-js-std`][rustdoc-js-tests]
and [`rustdoc-json`][rustdoc-json-tests] each feature an additional set of directives whose basic
syntax resembles the one of compiletest directives but which are ultimately read and checked by
separate tools. For more information, please read their respective chapters as linked above.
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-test-suite.md
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-html-test-suite.md
[rustdoc-js-tests]: ../rustdoc-internals/search.html#testing-the-search-engine
[rustdoc-json-tests]: ../rustdoc-internals/rustdoc-json-test-suite.md