Skip to content

Commit a7ac2cb

Browse files
camelidJoshua Nelson
authored and
Joshua Nelson
committed
Minor cleanup for "How to build and run"
1 parent 91a4afb commit a7ac2cb

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

src/building/how-to-build-and-run.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ git clone https://github.com/rust-lang/rust.git
1818
cd rust
1919
```
2020

21-
## Create a config.toml
21+
## Create a `config.toml`
2222

2323
To start, copy [`config.toml.example`] to `config.toml`:
2424

@@ -122,9 +122,7 @@ It is, in particular, very useful when you're doing some kind of
122122
"type-based refactoring", like renaming a method, or changing the
123123
signature of some function.
124124

125-
<a name=command></a>
126-
127-
Once you've created a config.toml, you are now ready to run
125+
Once you've created a `config.toml`, you are now ready to run
128126
`x.py`. There are a lot of options here, but let's start with what is
129127
probably the best "go to" command for building a local rust:
130128

@@ -177,7 +175,7 @@ build. The **full** `rustc` build (what you get if you say `./x.py build
177175
./x.py build library/core
178176
```
179177

180-
- Build the core and proc_macro libraries only
178+
- Build only the core and `proc_macro` libraries
181179

182180
```bash
183181
./x.py build library/core library/proc_macro
@@ -186,7 +184,7 @@ build. The **full** `rustc` build (what you get if you say `./x.py build
186184
Sometimes you might just want to test if the part you’re working on can
187185
compile. Using these commands you can test that it compiles before doing
188186
a bigger build to make sure it works with the compiler. As shown before
189-
you can also pass flags at the end such as --stage.
187+
you can also pass flags at the end such as `--stage`.
190188

191189
## Creating a rustup toolchain
192190

@@ -215,13 +213,13 @@ your local environment:
215213

216214
```bash
217215
$ rustc +stage1 -vV
218-
rustc 1.25.0-dev
216+
rustc 1.48.0-dev
219217
binary: rustc
220218
commit-hash: unknown
221219
commit-date: unknown
222220
host: x86_64-unknown-linux-gnu
223-
release: 1.25.0-dev
224-
LLVM version: 4.0
221+
release: 1.48.0-dev
222+
LLVM version: 11.0
225223
```
226224
## Other `x.py` commands
227225

@@ -252,4 +250,5 @@ everything up then you only need to run one command!
252250
./x.py clean
253251
```
254252

255-
`rm -rf build` works too, but then you have to rebuild LLVM.
253+
`rm -rf build` works too, but then you have to rebuild LLVM, which can take
254+
a long time (on the order of a half-hour).

0 commit comments

Comments
 (0)