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

Include information about setup defaults in how-to-build guide (#1694)

This commit is contained in:
Zachary Whiteley 2023-06-21 10:13:53 +01:00 committed by GitHub
parent 4b15de4985
commit 93fc2f3c01
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -67,8 +67,11 @@ 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.
To start, run `./x.py setup` and select the `compiler` defaults. This will do some initialization
and create a `config.toml` for you with reasonable defaults. If you use a different default (which
you'll likely want to do if you want to contribute to an area of rust other than the compiler, such
as rustdoc), make sure to read information about that default (located in `src/bootstrap/defaults`)
as the build process may be different for other defaults.
Alternatively, you can write `config.toml` by hand. See `config.example.toml` for all the available
settings and explanations of them. See `src/bootstrap/defaults` for common settings to change.