File tree Expand file tree Collapse file tree 1 file changed +6
-3
lines changed
src/doc/rustc-dev-guide/src/rustdoc-internals Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change 1
- # ` rustdoc ` tests
1
+ # the ` rustdoc ` test suite
2
2
3
3
This page is specifically about the ` rustdoc ` test suite, for other test suites used for testing rustdoc, see [ Rustdoc § Tests] ( ../rustdoc.md#tests ) .
4
4
5
- ` htmldocck.py ` is a custom checker script that uses [ XPath] to verify the HTML output of rustdoc.
5
+ The ` rustdoc ` test suite is specifically used to test the HTML output of rustdoc.
6
+
7
+ This is achived by means of ` htmldocck.py ` , a custom checker script that leverages [ XPath] .
6
8
7
9
[ XPath ] : https://en.wikipedia.org/wiki/XPath
8
10
@@ -14,7 +16,8 @@ In addition to the directives listed here,
14
16
[ compiletest directives] ( ../tests/directives.html ) .
15
17
16
18
All ` PATH ` s in directives are relative to the the rustdoc output directory (` build/TARGET/test/rustdoc/TESTNAME ` ),
17
- so it is conventional to use a ` #![crate_name = "foo"] ` attribute to avoid writing paths.
19
+ so it is conventional to use a ` #![crate_name = "foo"] ` attribute to avoid
20
+ having to write a long crate name multiple times.
18
21
To avoid repetion, ` - ` can be used in any ` PATH ` argument to re-use the previous ` PATH ` argument.
19
22
20
23
All arguments take the form of quoted strings,
You can’t perform that action at this time.
0 commit comments