diff options
| author | Rajkumar Natarajan <rajkumar.natarajan@synacor.com> | 2018-10-24 15:16:12 -0400 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2018-10-24 19:32:09 -0500 |
| commit | a15bfaba5e0c7b7d55ec41cf992c321afa4ca702 (patch) | |
| tree | dbda6168f274869d1e35d711a5837b50986b24fc /src/doc/rustc-dev-guide | |
| parent | d40622447e1d832d58c5e6cb104d890551c93b88 (diff) | |
| download | rust-a15bfaba5e0c7b7d55ec41cf992c321afa4ca702.tar.gz rust-a15bfaba5e0c7b7d55ec41cf992c321afa4ca702.zip | |
issue_100_4 Updated the rustc documentation location
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/compiler-documenting.md | 12 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/how-to-build-and-run.md | 6 |
2 files changed, 15 insertions, 3 deletions
diff --git a/src/doc/rustc-dev-guide/src/compiler-documenting.md b/src/doc/rustc-dev-guide/src/compiler-documenting.md index bf63c012055..97636fad5b4 100644 --- a/src/doc/rustc-dev-guide/src/compiler-documenting.md +++ b/src/doc/rustc-dev-guide/src/compiler-documenting.md @@ -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 @@ -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! \ No newline at end of file +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/ \ No newline at end of file diff --git a/src/doc/rustc-dev-guide/src/how-to-build-and-run.md b/src/doc/rustc-dev-guide/src/how-to-build-and-run.md index 4315cd70861..62461d3efdb 100644 --- a/src/doc/rustc-dev-guide/src/how-to-build-and-run.md +++ b/src/doc/rustc-dev-guide/src/how-to-build-and-run.md @@ -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/ \ No newline at end of file |