updated with review comments

This commit is contained in:
Rajkumar Natarajan 2018-09-28 23:01:47 -04:00 committed by Who? Me?!
parent e2d42fd84c
commit 4b8ba80e57
2 changed files with 12 additions and 4 deletions

View File

@ -16,7 +16,14 @@ test that it works on your target system. Youll want to run this command:
./x.py install
```
Note: If you are testing out a modification to a compiler, you might want to use it to compile some project.
Note: If you are testing out a modification to a compiler, you
might want to use it to compile some project.
Usually, you do not want to use ./x.py install for testing.
Rather, you should create a toolchain as discussed in how-to-build-and-run.html#creating-a-rustup-toolchain.
For example, if the toolchain you created is called foo, you would then invoke it with rustc +foo ... (where ... represents the rest of the arguments).
Rather, you should create a toolchain as discussed in
[here][create-rustup-toolchain].
For example, if the toolchain you created is called foo, you
would then invoke it with `rustc +foo ...` (where ... represents
the rest of the arguments).
[create-rustup-toolchain]: ./how-to-build-and-run.md#creating-a-rustup-toolchain

View File

@ -35,7 +35,8 @@ Much like individual tests or building certain components you can build only
## Document internal rustc items
Compiler documentation is not built by default - there's a flag in config.toml for achieving the same.
Compiler documentation is not built by default. There's a flag in
config.toml for achieving the same.
But, when enabled, compiler documentation does include internal items.
Next open up config.toml and make sure these two lines are set to true: