Skip to content

Commit 5577b35

Browse files
Suggest stage 1 if stage 0 fails
1 parent 23dbd33 commit 5577b35

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

CONTRIBUTING.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -394,9 +394,13 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].
394394
[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
395395

396396
In many cases, you don't need a full `./x.py doc`, which will build the entire
397-
stage 2 compiler. When updating documentation for the standard library, first
398-
try `./x.py doc --stage 0 src/libstd`. Results will should appear in
399-
`build/$TARGET/crate-docs`.
397+
stage 2 compiler and compile the various books published on
398+
[doc.rust-lang.org]. When updating documentation for the standard library,
399+
first try `./x.py doc --stage 0 src/libstd`. If that fails, or if you need to
400+
see the output from the latest version of `rustdoc`, use `--stage 1` instead of
401+
`--stage 0`. Results should appear in `build/$TARGET/crate-docs`.
402+
403+
[doc.rust-lang.org]: htts://doc.rust-lang.org
400404

401405
You can also use `rustdoc` directly to check small fixes. For example,
402406
`rustdoc src/doc/reference.md` will render reference to `doc/reference.html`.

0 commit comments

Comments
 (0)