From f4dc4a773880ae675d32b3e5f8190d51e081f429 Mon Sep 17 00:00:00 2001 From: Zachary Whiteley Date: Sat, 10 Jun 2023 11:16:29 +0100 Subject: [PATCH] Mention setup defaults in build guide Include information about what default is used for the guide (i.e., the compiler profile) and mention that different defaults (e.g., tools) may result in a different build process. --- src/building/how-to-build-and-run.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/building/how-to-build-and-run.md b/src/building/how-to-build-and-run.md index eb674c8fe..6444aab5f 100644 --- a/src/building/how-to-build-and-run.md +++ b/src/building/how-to-build-and-run.md @@ -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.