diff options
| author | binarycat <binarycat@envs.net> | 2025-03-18 13:19:33 -0500 |
|---|---|---|
| committer | binarycat <binarycat@envs.net> | 2025-03-18 13:19:33 -0500 |
| commit | 6893f0ac7aaf2c02e48c6434f98febe58def1f95 (patch) | |
| tree | 1e3ac9f2c33f3d5de7f2c3c351ed3ecfaad8cb22 /src | |
| parent | a172f23df0b108d6d615d1433ae3de51afd292b6 (diff) | |
| download | rust-6893f0ac7aaf2c02e48c6434f98febe58def1f95.tar.gz rust-6893f0ac7aaf2c02e48c6434f98febe58def1f95.zip | |
rustdoc test suite: clean up wording and intro
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/rustdoc-internals/htmldocck.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustdoc-internals/htmldocck.md b/src/doc/rustc-dev-guide/src/rustdoc-internals/htmldocck.md index b37c1ac3de1..97c40c8a820 100644 --- a/src/doc/rustc-dev-guide/src/rustdoc-internals/htmldocck.md +++ b/src/doc/rustc-dev-guide/src/rustdoc-internals/htmldocck.md @@ -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, |
