Skip to content

Commit 3b142e5

Browse files
committed
fix nits
1 parent c44964b commit 3b142e5

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

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

+7-5
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To start, copy [`config.toml.example`] to `config.toml`:
1919
Then you will want to open up the file and change the following
2020
settings (and possibly others, such as `llvm.ccache`):
2121

22-
```
22+
```toml
2323
[llvm]
2424
# Enables LLVM assertions, which will check that the LLVM bitcode generated
2525
# by the compiler is internally consistent. These are particularly helpful
@@ -53,15 +53,15 @@ Once you've created a config.toml, you are now ready to run
5353
probably the best "go to" command for building a local rust:
5454

5555
```
56-
./x.py build --incremental --stage 1 src/libstd
56+
./x.py build -i --stage 1 src/libstd
5757
```
5858

5959
What this command will do is the following:
6060

6161
- Using the beta compiler (also called stage 0), it will build the
6262
standard library and rustc from the `src` directory. The resulting
6363
compiler is called the "stage 1" compiler.
64-
- During this build, the `--incremental` switch enables incremental
64+
- During this build, the `-i` (or `--incremental`) switch enables incremental
6565
compilation, so that if you later rebuild after editing things in
6666
`src`, you can save a bit of time.
6767
- Using this stage 1 compiler, it will build the standard library.
@@ -72,7 +72,8 @@ get if you just say `./x.py build`) has quite a few more steps:
7272

7373
- Build stage1 rustc with stage0 compiler
7474
- Build libstd with stage1 compiler (up to here is the same)
75-
- Build stage2 rustc with stage1 compiler (this part is new)
75+
- Build rustc from `src` again, this time with the stage1 compiler (this part is new)
76+
- The resulting compiler here is called the "stage2" compiler
7677
- Build libstd with stage2 compiler
7778
- Build librustdoc and a bunch of other things
7879

@@ -83,7 +84,8 @@ of files in your `build` directory. In order to actually run the
8384
resulting rustc, we recommend creating rustup toolchains. The first
8485
one will run the stage1 compiler (which we built above). The second
8586
will execute the stage2 compiler (which we did not build, but which
86-
you will likely build at some point).
87+
you will likely need to build at some point; for example, if you want
88+
to run the entire test suite).
8789

8890
```
8991
> rustup toolchain link stage1 build/<host-triple>/stage1

0 commit comments

Comments
 (0)