diff options
| author | Rajkumar Natarajan <rajkumar.natarajan@synacor.com> | 2018-09-28 23:01:47 -0400 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2018-09-29 08:50:30 -0500 |
| commit | 12e5802e08754b6a36b183cda8c150a37653fa48 (patch) | |
| tree | 27768e21b6aa3413d263933929b6333c4fc7ebd6 /src/doc/rustc-dev-guide | |
| parent | 5ad3ed30bdea9c5c49ab26ecfd833292fff90431 (diff) | |
| download | rust-12e5802e08754b6a36b183cda8c150a37653fa48.tar.gz rust-12e5802e08754b6a36b183cda8c150a37653fa48.zip | |
updated with review comments
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/build-install-distribution-artifacts.md | 13 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/compiler-documenting.md | 3 |
2 files changed, 12 insertions, 4 deletions
diff --git a/src/doc/rustc-dev-guide/src/build-install-distribution-artifacts.md b/src/doc/rustc-dev-guide/src/build-install-distribution-artifacts.md index 521c441a2a5..7430ffb9b8d 100644 --- a/src/doc/rustc-dev-guide/src/build-install-distribution-artifacts.md +++ b/src/doc/rustc-dev-guide/src/build-install-distribution-artifacts.md @@ -16,7 +16,14 @@ test that it works on your target system. You’ll 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). \ No newline at end of file + 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 \ No newline at end of file diff --git a/src/doc/rustc-dev-guide/src/compiler-documenting.md b/src/doc/rustc-dev-guide/src/compiler-documenting.md index fceb73c9110..bf63c012055 100644 --- a/src/doc/rustc-dev-guide/src/compiler-documenting.md +++ b/src/doc/rustc-dev-guide/src/compiler-documenting.md @@ -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: |