mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix some whitespace issues (#483) 

Also, those are not sh scripts
This commit is contained in:
Tshepang Lekhonkhobe 2019-10-28 08:06:57 +02:00 committed by Yuki Okushi
parent c9db2d13b8
commit 604db2f293
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/compiler-documenting.md
View File

@ -9,13 +9,13 @@ available like the standard library. There’s two ways to go about this.
## Document everything ## Document everything
```bash ```ignore
./x.py doc ./x.py doc
``` ```
## If you want to avoid the whole Stage 2 build ## If you want to avoid the whole Stage 2 build
```bash ```ignore
./x.py doc --stage 1 ./x.py doc --stage 1
``` ```
@ -24,10 +24,10 @@ and then it documents the files.
## Document specific components ## Document specific components
```bash ```ignore
./x.py doc src/doc/book ./x.py doc src/doc/book
./x.py doc src/doc/nomicon ./x.py doc src/doc/nomicon
./x.py doc src/doc/book src/libstd ./x.py doc src/doc/book src/libstd
``` ```
Much like individual tests or building certain components you can build only Much like individual tests or building certain components you can build only
@ -41,14 +41,14 @@ But, when enabled, compiler documentation does include internal items.
Next open up config.toml and make sure these two lines are set to true: Next open up config.toml and make sure these two lines are set to true:
```bash ```toml
docs = true docs = true
compiler-docs = true compiler-docs = true
``` ```
When you want to build the compiler docs as well run this command: When you want to build the compiler docs as well run this command:
```bash ```ignore
./x.py doc ./x.py doc
``` ```