about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorJoshua Nelson <jyn514@gmail.com>2020-06-23 17:53:09 -0400
committerWho? Me?! <mark-i-m@users.noreply.github.com>2020-06-23 17:40:16 -0500
commitc78b9831cb95f2e5597e67e21c8282e3856d6bfc (patch)
tree485b053aa04bf13756185283ee449978fcd977bd /src/doc/rustc-dev-guide
parent1b7f28b287bd1367946b90c2afd1dd814ed62731 (diff)
downloadrust-c78b9831cb95f2e5597e67e21c8282e3856d6bfc.tar.gz
rust-c78b9831cb95f2e5597e67e21c8282e3856d6bfc.zip
Move x.py commands to overview
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/rustdoc-internals.md3
-rw-r--r--src/doc/rustc-dev-guide/src/rustdoc.md6
2 files changed, 5 insertions, 4 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustdoc-internals.md b/src/doc/rustc-dev-guide/src/rustdoc-internals.md
index 59cee9f1c44..ab3bf1b3011 100644
--- a/src/doc/rustc-dev-guide/src/rustdoc-internals.md
+++ b/src/doc/rustc-dev-guide/src/rustdoc-internals.md
@@ -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.
diff --git a/src/doc/rustc-dev-guide/src/rustdoc.md b/src/doc/rustc-dev-guide/src/rustdoc.md
index 0e80c069941..6ac944697ad 100644
--- a/src/doc/rustc-dev-guide/src/rustdoc.md
+++ b/src/doc/rustc-dev-guide/src/rustdoc.md
@@ -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