mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move "create a config.toml" after the section explaning x.py

This commit is contained in:
Joshua Nelson 2022-12-08 09:45:53 -06:00 committed by Joshua Nelson
parent b36e2ff71d
commit 966d6e97a7
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/building/how-to-build-and-run.md
View File

@ -21,18 +21,6 @@ git clone https://github.com/rust-lang/rust.git
cd rust cd rust
``` ```
## Create a `config.toml`
To start, run `./x.py setup`. This will do some initialization and create a
`config.toml` for you with reasonable defaults.
Alternatively, you can write `config.toml` by hand. See `config.toml.example`
for all the available settings and explanations of them. See `src/bootstrap/defaults` for common settings to change.
If you have already built `rustc` and you change settings related to LLVM, then you may have to
execute `rm -rf build` for subsequent configuration changes to take effect. Note that `./x.py
clean` will not cause a rebuild of LLVM.
## What is `x.py`? ## What is `x.py`?
`x.py` is the build tool for the `rust` repository. It can build docs, run tests, and compile the `x.py` is the build tool for the `rust` repository. It can build docs, run tests, and compile the
@ -51,6 +39,18 @@ of a checkout. It also looks up the appropriate version of `python` to use.
You can install it with `cargo install --path src/tools/x`. You can install it with `cargo install --path src/tools/x`.
## Create a `config.toml`
To start, run `./x.py setup`. This will do some initialization and create a
`config.toml` for you with reasonable defaults.
Alternatively, you can write `config.toml` by hand. See `config.toml.example` for all the available
settings and explanations of them. See `src/bootstrap/defaults` for common settings to change.
If you have already built `rustc` and you change settings related to LLVM, then you may have to
execute `rm -rf build` for subsequent configuration changes to take effect. Note that `./x.py
clean` will not cause a rebuild of LLVM.
## Building the Compiler ## Building the Compiler
Note that building will require a relatively large amount of storage space. Note that building will require a relatively large amount of storage space.