summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDylan MacKenzie <ecstaticmorse@gmail.com>2020-04-28 09:34:07 -0700
committerDylan MacKenzie <ecstaticmorse@gmail.com>2020-04-28 10:14:56 -0700
commit5577b3554d3d111f7cff683669b5f7d37539d18d (patch)
tree4a3b71eff81145f80d651dc9689b3406b9f0f103 /CONTRIBUTING.md
parent23dbd33d9372bdb422eeb3978f4af90faebfb989 (diff)
downloadrust-5577b3554d3d111f7cff683669b5f7d37539d18d.tar.gz
rust-5577b3554d3d111f7cff683669b5f7d37539d18d.zip
Suggest stage 1 if stage 0 fails
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 121aa1dbf0c..e674cf61b51 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -394,9 +394,13 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].
 [rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
 
 In many cases, you don't need a full `./x.py doc`, which will build the entire
-stage 2 compiler. When updating documentation for the standard library, first
-try `./x.py doc --stage 0 src/libstd`. Results will should appear in
-`build/$TARGET/crate-docs`.
+stage 2 compiler and compile the various books published on
+[doc.rust-lang.org]. When updating documentation for the standard library,
+first try `./x.py doc --stage 0 src/libstd`. If that fails, or if you need to
+see the output from the latest version of `rustdoc`, use `--stage 1` instead of
+`--stage 0`. Results should appear in `build/$TARGET/crate-docs`.
+
+[doc.rust-lang.org]: htts://doc.rust-lang.org
 
 You can also use `rustdoc` directly to check small fixes. For example,
 `rustdoc src/doc/reference.md` will render reference to `doc/reference.html`.