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 521c441a2a5c..7430ffb9b8dc 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 fceb73c91100..bf63c012055a 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: