Skip to content

issue_100_4 Updated the rustc documentation location #218

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.

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

Merged
merged 1 commit into from
Oct 25, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 9 additions & 3 deletions src/compiler-documenting.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ available like the standard library. There’s two ways to go about this.
./x.py doc --stage 1
```

First the compiler and rustdoc get built to make sure everything is okay
First the compiler and rustdoc get built to make sure everything is okay
and then it documents the files.

## Document specific components
Expand Down Expand Up @@ -52,5 +52,11 @@ When you want to build the compiler docs as well run this command:
./x.py doc
```

This will see that the docs and compiler-docs options are set to true
and build the normally hidden compiler docs!
This will see that the docs and compiler-docs options are set to true
and build the normally hidden compiler docs!

### Compiler Documentation

The documentation for the rust components are found at [rustc doc].

[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
6 changes: 6 additions & 0 deletions src/how-to-build-and-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,3 +330,9 @@ everything up then you only need to run one command!
```bash
> ./x.py clean
```

### Compiler Documentation

The documentation for the rust components are found at [rustc doc].

[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/