rustup
rustup copied to clipboard
Add details of each setting in the toolchain file
The format of the new section is modeled after the cargo docs, for example: https://doc.rust-lang.org/cargo/reference/profiles.html#profile-settings
This is mostly a reorganization of the existing content to make it easier to scan for relevant details, but a few new details have also been added:
- For
channel, the format is now explained in the same format as in concepts/toolchains.md, but with the more limited form thatrust-toolchain.tomlaccepts. This is based on the text that was here previously; I haven't verified if the code is actually this strict. - The
profilesection mentions that the default profile is not necessarily the profile nameddefault, which is subtle detail that can be confusing. - The
componentssection notes that the list is additive with the profile's list of components. - The
targetsfield is now documented, previously it wasn't mentioned other than to say it's ignored withpath.
You can check out this rendered page.
Friendly ping, would love to get this merged :)
I am going to merge this PR. If we find some grammar issues we can fix them later. Thanks! Sorry for the long wait.