about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorTshepang Lekhonkhobe <tshepang@gmail.com>2019-11-07 22:12:50 +0200
committerWho? Me?! <mark-i-m@users.noreply.github.com>2019-11-08 10:19:32 -0600
commit36314738f3b221f77d6c6880c87f2a5b0fc91570 (patch)
treee9e4c36ed9f8418398eaf1fe7f7eb9b75d472616 /src/doc/rustc-dev-guide
parenteb26cd56ca8b27a76d3652d9e007b27b6726169e (diff)
downloadrust-36314738f3b221f77d6c6880c87f2a5b0fc91570.tar.gz
rust-36314738f3b221f77d6c6880c87f2a5b0fc91570.zip
trim down "Document rustc"
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/building/compiler-documenting.md24
1 files changed, 7 insertions, 17 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/compiler-documenting.md b/src/doc/rustc-dev-guide/src/building/compiler-documenting.md
index 345a324bd7c..16df10f7201 100644
--- a/src/doc/rustc-dev-guide/src/building/compiler-documenting.md
+++ b/src/doc/rustc-dev-guide/src/building/compiler-documenting.md
@@ -9,13 +9,13 @@ since documentation is more about the content.
 
 ## Document everything
 
-```ignore
+```bash
 ./x.py doc
 ```
 
 ## If you want to avoid the whole Stage 2 build
 
-```ignore
+```bash
 ./x.py doc --stage 1
 ```
 
@@ -24,7 +24,7 @@ and then it documents the files.
 
 ## Document specific components
 
-```ignore
+```bash
 ./x.py doc src/doc/book
 ./x.py doc src/doc/nomicon
 ./x.py doc src/doc/book src/libstd
@@ -35,25 +35,15 @@ 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.
-But, when enabled, compiler documentation does include internal items.
-
-Next open up config.toml and make sure these two lines are set to true:
+Compiler documentation is not built by default. To enable it, modify config.toml:
 
 ```toml
-docs = true
+[build]
 compiler-docs = true
 ```
 
-When you want to build the compiler docs as well run this command:
-
-```ignore
-./x.py doc
-```
-
-This will see that the docs and compiler-docs options are set to true
-and build the normally hidden compiler docs!
+Note that when enabled,
+documentation for internal compiler items will also be built.
 
 ### Compiler Documentation