improve comments and docs
Signed-off-by: onur-ozkan <work@onurozkan.dev>
This commit is contained in:
parent
09eb3b3f78
commit
257e73f3a3
|
|
@ -66,13 +66,12 @@ The stage0 compiler is by default the very recent _beta_ `rustc` compiler and it
|
|||
associated dynamic libraries, which `./x.py` will download for you. (You can
|
||||
also configure `./x.py` to change stage0 to something else.)
|
||||
|
||||
The stage0 compiler is then used only to compile [`src/bootstrap`] and [`compiler/rustc`].
|
||||
When assembling the libraries and binaries that will become the stage1 `rustc` compiler,
|
||||
the freshly compiled `rustc` and beta `std` are used.
|
||||
The precompiled stage0 compiler is then used only to compile [`src/bootstrap`] and [`compiler/rustc`]
|
||||
with precompiled stage0 std.
|
||||
|
||||
Note that to build the stage1 compiler we use the precompiled beta compiler and beta std from stage0.
|
||||
Therefore, to use a compiler with a std that is freshly built from the tree, you need to build the
|
||||
stage2 compiler.
|
||||
Note that to build the stage1 compiler we use the precompiled stage0 compiler and std.
|
||||
Therefore, to use a compiler with a std that is freshly built from the tree, you need to
|
||||
build the stage2 compiler.
|
||||
|
||||
There are two concepts at play here: a compiler (with its set of dependencies) and its
|
||||
'target' or 'object' libraries (`std` and `rustc`). Both are staged, but in a staggered manner.
|
||||
|
|
@ -87,7 +86,7 @@ The rustc source code is then compiled with the `stage0` compiler to produce the
|
|||
|
||||
### Stage 2: the truly current compiler
|
||||
|
||||
We then rebuild our `stage1` compiler with in-tree std to produce the `stage2`
|
||||
We then rebuild the compiler using `stage1` compiler with in-tree std to produce the `stage2`
|
||||
compiler.
|
||||
|
||||
The `stage1` compiler itself was built by precompiled `stage0` compiler and std
|
||||
|
|
@ -194,8 +193,8 @@ include, but are not limited to:
|
|||
without building `rustc` from source ('build with `stage0`, then test the
|
||||
artifacts'). If you're working on the standard library, this is normally the
|
||||
test command you want.
|
||||
- `./x build --stage 0` means to build with the beta `rustc`.
|
||||
- `./x doc --stage 0` means to document using the beta `rustdoc`.
|
||||
- `./x build --stage 0` means to build with the stage0 `rustc`.
|
||||
- `./x doc --stage 0` means to document using the stage0 `rustdoc`.
|
||||
|
||||
#### Examples of what *not* to do
|
||||
|
||||
|
|
@ -442,6 +441,6 @@ compiler itself uses to run. These aren't actually used by artifacts the new
|
|||
compiler generates. This step also copies the `rustc` and `rustdoc` binaries we
|
||||
generated into `build/$HOST/stage/bin`.
|
||||
|
||||
The `stage1/bin/rustc` is a fully functional compiler built with the beta compiler and std.
|
||||
To use a compiler built entirely from source with the in-tree compiler and std, you need to build
|
||||
the stage2 compiler, which is compiled using the stage1 compiler and std.
|
||||
The `stage1/bin/rustc` is a fully functional compiler built with stage0 (precompiled) compiler and std.
|
||||
To use a compiler built entirely from source with the in-tree compiler and std, you need to build the
|
||||
stage2 compiler, which is compiled using the stage1 (in-tree) compiler and std.
|
||||
|
|
|
|||
|
|
@ -269,7 +269,6 @@ you will likely need to build at some point; for example, if you want
|
|||
to run the entire test suite).
|
||||
|
||||
```bash
|
||||
rustup toolchain link stage0 build/host/stage0-sysroot # beta compiler + beta std
|
||||
rustup toolchain link stage1 build/host/stage1
|
||||
rustup toolchain link stage2 build/host/stage2
|
||||
```
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ Look for existing targets to use as examples.
|
|||
After adding your target to the `rustc_target` crate you may want to add
|
||||
`core`, `std`, ... with support for your new target. In that case you will
|
||||
probably need access to some `target_*` cfg. Unfortunately when building with
|
||||
stage0 (the beta compiler), you'll get an error that the target cfg is
|
||||
stage0 (a precompiled compiler), you'll get an error that the target cfg is
|
||||
unexpected because stage0 doesn't know about the new target specification and
|
||||
we pass `--check-cfg` in order to tell it to check.
|
||||
|
||||
|
|
|
|||
|
|
@ -310,51 +310,15 @@ lets you use `cargo fmt`.
|
|||
[the section on vscode]: suggested.md#configuring-rust-analyzer-for-rustc
|
||||
[the section on rustup]: how-to-build-and-run.md?highlight=rustup#creating-a-rustup-toolchain
|
||||
|
||||
## Faster builds with `--keep-stage`.
|
||||
## Faster Builds with CI-rustc
|
||||
|
||||
Sometimes just checking whether the compiler builds is not enough. A common
|
||||
example is that you need to add a `debug!` statement to inspect the value of
|
||||
some state or better understand the problem. In that case, you don't really need
|
||||
a full build. By bypassing bootstrap's cache invalidation, you can often get
|
||||
these builds to complete very fast (e.g., around 30 seconds). The only catch is
|
||||
this requires a bit of fudging and may produce compilers that don't work (but
|
||||
that is easily detected and fixed).
|
||||
|
||||
The sequence of commands you want is as follows:
|
||||
|
||||
- Initial build: `./x build library`
|
||||
- As [documented previously], this will build a functional stage1 compiler as
|
||||
part of running all stage0 commands (which include building a `std`
|
||||
compatible with the stage1 compiler) as well as the first few steps of the
|
||||
"stage 1 actions" up to "stage1 (sysroot stage1) builds std".
|
||||
- Subsequent builds: `./x build library --keep-stage 1`
|
||||
- Note that we added the `--keep-stage 1` flag here
|
||||
|
||||
[documented previously]: ./how-to-build-and-run.md#building-the-compiler
|
||||
|
||||
As mentioned, the effect of `--keep-stage 1` is that we just _assume_ that the
|
||||
old standard library can be re-used. If you are editing the compiler, this is
|
||||
almost always true: you haven't changed the standard library, after all. But
|
||||
sometimes, it's not true: for example, if you are editing the "metadata" part of
|
||||
the compiler, which controls how the compiler encodes types and other states
|
||||
into the `rlib` files, or if you are editing things that wind up in the metadata
|
||||
(such as the definition of the MIR).
|
||||
|
||||
**The TL;DR is that you might get weird behavior from a compile when using
|
||||
`--keep-stage 1`** -- for example, strange [ICEs](../appendix/glossary.html#ice)
|
||||
or other panics. In that case, you should simply remove the `--keep-stage 1`
|
||||
from the command and rebuild. That ought to fix the problem.
|
||||
|
||||
You can also use `--keep-stage 1` when running tests. Something like this:
|
||||
|
||||
- Initial test run: `./x test tests/ui`
|
||||
- Subsequent test run: `./x test tests/ui --keep-stage 1`
|
||||
|
||||
### Iterating the standard library with `--keep-stage`
|
||||
|
||||
If you are making changes to the standard library, you can use `./x build
|
||||
--keep-stage 0 library` to iteratively rebuild the standard library without
|
||||
rebuilding the compiler.
|
||||
If you are not working on the compiler, you often don't need to build the compiler tree.
|
||||
For example, you can skip building the compiler and only build the `library` tree or the
|
||||
tools under `src/tools`. To achieve that, you have to enable this by setting the `download-rustc`
|
||||
option in your configuration. This tells bootstrap to use the latest nightly compiler for `stage > 0`
|
||||
steps, meaning it will have two precompiled compilers: stage0 compiler and `download-rustc` compiler
|
||||
for `stage > 0` steps. This way, it will never need to build the in-tree compiler. As a result, your
|
||||
build time will be significantly reduced by not building the in-tree compiler.
|
||||
|
||||
## Using incremental compilation
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue