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

rustdoc test suite: clean up wording and intro

This commit is contained in:
binarycat 2025-03-18 13:19:33 -05:00
parent f248d2f57c
commit 72aa06dff1
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/rustdoc-internals/htmldocck.md
View File

@ -1,8 +1,10 @@
# `rustdoc` tests
# the `rustdoc` test suite
This page is specifically about the `rustdoc` test suite, for other test suites used for testing rustdoc, see [Rustdoc § Tests](../rustdoc.md#tests).
`htmldocck.py` is a custom checker script that uses [XPath] to verify the HTML output of rustdoc.
The `rustdoc` test suite is specifically used to test the HTML output of rustdoc.
This is achived by means of `htmldocck.py`, a custom checker script that leverages [XPath].
[XPath]: https://en.wikipedia.org/wiki/XPath
@ -14,7 +16,8 @@ In addition to the directives listed here,
[compiletest directives](../tests/directives.html).
All `PATH`s in directives are relative to the the rustdoc output directory (`build/TARGET/test/rustdoc/TESTNAME`),
so it is conventional to use a `#![crate_name = "foo"]` attribute to avoid writing paths.
so it is conventional to use a `#![crate_name = "foo"]` attribute to avoid
having to write a long crate name multiple times.
To avoid repetion, `-` can be used in any `PATH` argument to re-use the previous `PATH` argument.
All arguments take the form of quoted strings,