Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Direct contributors to try stage 0 rustdoc first #71645

Merged
merged 2 commits into from
May 4, 2020
Merged

Direct contributors to try stage 0 rustdoc first #71645

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23dbd33
Direct contributors to try stage 0 rustdoc first
ecstatic-morse Apr 28, 2020
5577b35
Suggest stage 1 if stage 0 fails
ecstatic-morse Apr 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,10 +393,14 @@ 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`. You can use `rustdoc` directly
to check small fixes. For example, `rustdoc src/doc/reference.md` will render
reference to `doc/reference.html`. The CSS might be messed up, but you can
verify that the HTML is right.
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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should definitely recommend stage 1 (which should always work) if this fails, which it could, as rustdoc doesn't run on stage 0 in CI, so some annotations may be missing or otherwise incompatible with stage 0. Lack of effective cfg(bootstrap) for docs makes that a particularly thorny problem.


You can also use `rustdoc` directly to check small fixes. For example,
`rustdoc src/doc/reference.md` will render reference to `doc/reference.html`.
The CSS might be messed up, but you can verify that the HTML is right.

Additionally, contributions to the [rustc-dev-guide] are always welcome. Contributions
can be made directly at [the
Expand Down