Skip to content

Commit

Permalink
Suggest profile = "user" in the README
Browse files Browse the repository at this point in the history
This sets several useful defaults, like `extended = true`, and gives us a path forward for changing
global defaults without breaking distros.
  • Loading branch information
jyn514 committed Dec 24, 2022
1 parent 7dae1b0 commit 1bd1b25
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,11 @@ See [the rustc-dev-guide for more info][sysllvm].

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

```sh
cp config.toml.example config.toml
printf 'profile = "user" \nchangelog-seen = 2 \n' > config.toml
```

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

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

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

Expand Down Expand Up @@ -215,7 +214,7 @@ Windows build triples are:
- `x86_64-pc-windows-msvc`

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

Expand Down

0 comments on commit 1bd1b25

Please sign in to comment.