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

Links to htmldocck/@has/matches for searchability

This commit is contained in:
Alexis Bourget 2020-11-12 00:45:34 +01:00 committed by Joshua Nelson
parent 10869964a7
commit f36f645daf
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/rustdoc-internals.md
View File

@ -177,7 +177,8 @@ a set of tests in `src/test/rustdoc` that make sure the final HTML is what we
expect in various situations. These tests also use a supplementary script, expect in various situations. These tests also use a supplementary script,
`src/etc/htmldocck.py`, that allows it to look through the final HTML using `src/etc/htmldocck.py`, that allows it to look through the final HTML using
XPath notation to get a precise look at the output. The full description of all XPath notation to get a precise look at the output. The full description of all
the commands available to rustdoc tests is in `htmldocck.py`. the commands available to rustdoc tests (e.g. [`@has`] and [`@matches`]) is in
[`htmldocck.py`].
To use multiple crates in a rustdoc test, add `// aux-build:filename.rs` To use multiple crates in a rustdoc test, add `// aux-build:filename.rs`
to the top of the test file. `filename.rs` should be placed in an `auxiliary` to the top of the test file. `filename.rs` should be placed in an `auxiliary`
@ -193,6 +194,10 @@ that features results in all tabs can be found in `basic.js`. The basic idea is
that you match a given `QUERY` with a set of `EXPECTED` results, complete with that you match a given `QUERY` with a set of `EXPECTED` results, complete with
the full item path of each item. the full item path of each item.
[`htmldocck.py`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py
[`@has`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py#L39
[`@matches`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py#L44
## Testing locally ## Testing locally
Some features of the generated HTML documentation might require local Some features of the generated HTML documentation might require local