Skip to content

Commit ef7bfef

Browse files
authored
Include information about setup defaults in how-to-build guide (#1694)
1 parent d2d2386 commit ef7bfef

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

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

+5-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,11 @@ You can install it with `cargo install --path src/tools/x`.
6767

6868
## Create a `config.toml`
6969

70-
To start, run `./x.py setup`. This will do some initialization and create a
71-
`config.toml` for you with reasonable defaults.
70+
To start, run `./x.py setup` and select the `compiler` defaults. This will do some initialization
71+
and create a `config.toml` for you with reasonable defaults. If you use a different default (which
72+
you'll likely want to do if you want to contribute to an area of rust other than the compiler, such
73+
as rustdoc), make sure to read information about that default (located in `src/bootstrap/defaults`)
74+
as the build process may be different for other defaults.
7275

7376
Alternatively, you can write `config.toml` by hand. See `config.example.toml` for all the available
7477
settings and explanations of them. See `src/bootstrap/defaults` for common settings to change.

0 commit comments

Comments
 (0)