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

Move x.py commands to overview

This commit is contained in:
Joshua Nelson 2020-06-23 17:53:09 -04:00 committed by Who? Me?!
parent 4329b8e91a
commit 2e104620d1
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/rustdoc-internals.md
View File

@ -192,6 +192,3 @@ runtime. These tests don't have as thorough of a writeup, but a broad example
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
the full item path of each item.
You can run tests using the name of the folder. For example,
`x.py test --stage 1 src/test/rustdoc` will run the output tests using a stage1 rustdoc.

6
src/rustdoc.md
View File

@ -41,6 +41,8 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
* The completed docs will be available in `build/$TARGET/doc/std`, though the
bundle is meant to be used as though you would copy out the `doc` folder to
a web server, since that's where the CSS/JS and landing page are.
* Use `x.py test --stage 1 src/test/rustdoc*` to run the tests using a stage1 rustdoc.
* See [rustdoc internals] for more information about tests.
* Most of the HTML printing code is in `html/format.rs` and `html/render.rs`.
It's in a bunch of `fmt::Display` implementations and supplementary
functions.
@ -58,4 +60,6 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
## See also
For more details about how rustdoc works, see the page on [rustdoc internals](./rustdoc-internals.md).
For more details about how rustdoc works, see the page on [rustdoc internals].
[rustdoc internals]: ./rustdoc-internals.md