Skip to content

Commit 85ab152

Browse files
committed
Update bootstrap readme
- Reflect changes in x.py defaults - Remove recommendation to use nightly for incremental; it works fine on beta - Remove note that incremental chooses stage 1 by default; stage 1 is already the default - Update Discord -> Zulip
1 parent 7d289ae commit 85ab152

File tree

1 file changed

+10
-28
lines changed

1 file changed

+10
-28
lines changed

src/bootstrap/README.md

+10-28
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ The script accepts commands, flags, and arguments to determine what to do:
2626

2727
```
2828
# build the whole compiler
29-
./x.py build
29+
./x.py build --stage 2
3030
3131
# build the stage1 compiler
32-
./x.py build --stage 1
32+
./x.py build
3333
3434
# build stage0 libstd
3535
./x.py build --stage 0 library/std
@@ -43,8 +43,8 @@ The script accepts commands, flags, and arguments to determine what to do:
4343
that belong to stage n or earlier:
4444

4545
```
46-
# keep old build products for stage 0 and build stage 1
47-
./x.py build --keep-stage 0 --stage 1
46+
# build stage 1, keeping old build products for stage 0
47+
./x.py build --keep-stage 0
4848
```
4949

5050
* `test` - a command for executing unit tests. Like the `build` command this
@@ -123,24 +123,8 @@ that (b) leverage Rust as much as possible!
123123

124124
## Incremental builds
125125

126-
You can configure rustbuild to use incremental compilation. Because
127-
incremental is new and evolving rapidly, if you want to use it, it is
128-
recommended that you replace the snapshot with a locally installed
129-
nightly build of rustc. You will want to keep this up to date.
130-
131-
To follow this course of action, first thing you will want to do is to
132-
install a nightly, presumably using `rustup`. You will then want to
133-
configure your directory to use this build, like so:
134-
135-
```sh
136-
# configure to use local rust instead of downloading a beta.
137-
# `--local-rust-root` is optional here. If elided, we will
138-
# use whatever rustc we find on your PATH.
139-
$ ./configure --local-rust-root=~/.cargo/ --enable-local-rebuild
140-
```
141-
142-
After that, you can use the `--incremental` flag to actually do
143-
incremental builds:
126+
You can configure rustbuild to use incremental compilation with the
127+
`--incremental` flag:
144128

145129
```sh
146130
$ ./x.py build --incremental
@@ -150,9 +134,7 @@ The `--incremental` flag will store incremental compilation artifacts
150134
in `build/<host>/stage0-incremental`. Note that we only use incremental
151135
compilation for the stage0 -> stage1 compilation -- this is because
152136
the stage1 compiler is changing, and we don't try to cache and reuse
153-
incremental artifacts across different versions of the compiler. For
154-
this reason, `--incremental` defaults to `--stage 1` (though you can
155-
manually select a higher stage, if you prefer).
137+
incremental artifacts across different versions of the compiler.
156138

157139
You can always drop the `--incremental` to build as normal (but you
158140
will still be using the local nightly as your bootstrap).
@@ -331,8 +313,8 @@ are:
331313
`Config` struct.
332314
* Adding a sanity check? Take a look at `bootstrap/sanity.rs`.
333315

334-
If you have any questions feel free to reach out on `#infra` channel in the
335-
[Rust Discord server][rust-discord] or ask on internals.rust-lang.org. When
316+
If you have any questions feel free to reach out on the `#t-infra` channel in
317+
the [Rust Zulip server][rust-zulip] or ask on internals.rust-lang.org. When
336318
you encounter bugs, please file issues on the rust-lang/rust issue tracker.
337319

338-
[rust-discord]: https://discord.gg/rust-lang
320+
[rust-zulip]: https://rust-lang.zulipchat.com/#narrow/stream/242791-t-infra

0 commit comments

Comments
 (0)