Skip to content

Commit ccbf24e

Browse files
Update rustc-dev-guide about tests/rustdoc renamed into tests/rustdoc-html
1 parent 6de12f4 commit ccbf24e

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

src/doc/rustc-dev-guide/src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
- [Parallel compilation](./parallel-rustc.md)
101101
- [Rustdoc internals](./rustdoc-internals.md)
102102
- [Search](./rustdoc-internals/search.md)
103-
- [The `rustdoc` test suite](./rustdoc-internals/rustdoc-test-suite.md)
103+
- [The `rustdoc-html` test suite](./rustdoc-internals/rustdoc-html-test-suite.md)
104104
- [The `rustdoc-gui` test suite](./rustdoc-internals/rustdoc-gui-test-suite.md)
105105
- [The `rustdoc-json` test suite](./rustdoc-internals/rustdoc-json-test-suite.md)
106106
- [GPU offload internals](./offload/internals.md)

src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md renamed to src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-html-test-suite.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# The `rustdoc` test suite
1+
# The `rustdoc-html` test suite
22

3-
This page is about the test suite named `rustdoc` used to test the HTML output of `rustdoc`.
3+
This page is about the test suite named `rustdoc-html` used to test the HTML output of `rustdoc`.
44
For other rustdoc-specific test suites, see [Rustdoc test suites].
55

66
Each test file in this test suite is simply a Rust source file `file.rs` sprinkled with

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Also, talk about how it works
2424
## jsondocck
2525

2626
[jsondocck] processes directives given in comments, to assert that the values in the output are expected.
27-
It's a lot like [htmldocck](./rustdoc-test-suite.md) in that way.
27+
It's a lot like [htmldocck](./rustdoc-html-test-suite.md) in that way.
2828

2929
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.
3030

src/doc/rustc-dev-guide/src/tests/compiletest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The following test suites are available, with links for more information:
8282

8383
| Test suite | Purpose |
8484
|--------------------------------------|--------------------------------------------------------------------------|
85-
| [`rustdoc`][rustdoc-html-tests] | Check HTML output of `rustdoc` |
85+
| [`rustdoc-html`][rustdoc-html-tests] | Check HTML output of `rustdoc` |
8686
| [`rustdoc-gui`][rustdoc-gui-tests] | Check `rustdoc`'s GUI using a web browser |
8787
| [`rustdoc-js`][rustdoc-js-tests] | Check `rustdoc`'s search engine and index |
8888
| [`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
9494
are also run when executing rustc.
9595
Run-make tests pertaining to rustdoc are typically named `run-make/rustdoc-*/`.
9696

97-
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-test-suite.md
97+
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-html-test-suite.md
9898
[rustdoc-gui-tests]: ../rustdoc-internals/rustdoc-gui-test-suite.md
9999
[rustdoc-js-tests]: ../rustdoc-internals/search.md#testing-the-search-engine
100100
[rustdoc-json-tests]: ../rustdoc-internals/rustdoc-json-test-suite.md

src/doc/rustc-dev-guide/src/tests/directives.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,12 +308,12 @@ Asked in
308308

309309
#### Test-suite-specific directives
310310

311-
The test suites [`rustdoc`][rustdoc-html-tests], [`rustdoc-js`/`rustdoc-js-std`][rustdoc-js-tests]
311+
The test suites [`rustdoc-html`][rustdoc-html-tests], [`rustdoc-js`/`rustdoc-js-std`][rustdoc-js-tests]
312312
and [`rustdoc-json`][rustdoc-json-tests] each feature an additional set of directives whose basic
313313
syntax resembles the one of compiletest directives but which are ultimately read and checked by
314314
separate tools. For more information, please read their respective chapters as linked above.
315315

316-
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-test-suite.md
316+
[rustdoc-html-tests]: ../rustdoc-internals/rustdoc-html-test-suite.md
317317
[rustdoc-js-tests]: ../rustdoc-internals/search.html#testing-the-search-engine
318318
[rustdoc-json-tests]: ../rustdoc-internals/rustdoc-json-test-suite.md
319319

0 commit comments

Comments
 (0)