Skip to content

Commit 1bd1b25

Browse files
committed
Suggest profile = "user" in the README
This sets several useful defaults, like `extended = true`, and gives us a path forward for changing global defaults without breaking distros.
1 parent 7dae1b0 commit 1bd1b25

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,11 @@ See [the rustc-dev-guide for more info][sysllvm].
8787

8888
The Rust build system uses a file named `config.toml` in the root of the
8989
source tree to determine various configuration settings for the build.
90-
Copy the default `config.toml.example` to `config.toml` to get started.
90+
Set up the defaults intended for distros to get started. You can see a full list of options
91+
in `config.toml.example`.
9192

9293
```sh
93-
cp config.toml.example config.toml
94+
printf 'profile = "user" \nchangelog-seen = 2 \n' > config.toml
9495
```
9596

9697
If you plan to use `x.py install` to create an installation, it is recommended
@@ -104,10 +105,8 @@ See [the rustc-dev-guide for more info][sysllvm].
104105

105106
When complete, `./x.py install` will place several programs into
106107
`$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
107-
API-documentation tool. This install does not include [Cargo],
108-
Rust's package manager. To build and install Cargo, you may
109-
run `./x.py install cargo` or set the `build.extended` key in
110-
`config.toml` to `true` to build and install all tools.
108+
API-documentation tool. If you've set `profile = "user"` or `build.extended = true`, it will
109+
also include [Cargo], Rust's package manager.
111110

112111
[Cargo]: https://github.com/rust-lang/cargo
113112

@@ -215,7 +214,7 @@ Windows build triples are:
215214
- `x86_64-pc-windows-msvc`
216215

217216
The build triple can be specified by either specifying `--build=<triple>` when
218-
invoking `x.py` commands, or by copying the `config.toml` file (as described
217+
invoking `x.py` commands, or by creating a `config.toml` file (as described
219218
in [Installing From Source](#installing-from-source)), and modifying the
220219
`build` option under the `[build]` section.
221220

0 commit comments

Comments
 (0)