Add details of each setting in the toolchain file#3067
Merged
Conversation
0xPoe
reviewed
Sep 19, 2022
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: 1. For `channel`, the format is now explained in the same format as in concepts/toolchains.md, but with the more limited form that `rust-toolchain.toml` accepts. This is based on the text that was here previously; I haven't verified if the code is actually this strict. 2. The `profile` section mentions that the default profile is not necessarily the profile named `default`, which is subtle detail that can be confusing. 3. The `components` section notes that the list is additive with the profile's list of components. 4. The `targets` field is now documented, previously it wasn't mentioned other than to say it's ignored with `path`.
8d75fba to
7bfbd3b
Compare
0xPoe
approved these changes
Oct 8, 2022
Member
0xPoe
left a comment
There was a problem hiding this comment.
Looks good to me. Thanks for your patch!
But I am not a native English speaker, so I'd like to wait for approval from @kinnison or @rbtcollins before we merge it.
Member
|
You can check out this rendered page. |
Contributor
Author
|
Friendly ping, would love to get this merged :) |
Member
|
I am going to merge this PR. If we find some grammar issues we can fix them later. Thanks! Sorry for the long wait. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
channel, the format is now explained in the same format as inconcepts/toolchains.md, but with the more limited form that
rust-toolchain.tomlaccepts. This is based on the text that washere previously; I haven't verified if the code is actually this
strict.
profilesection mentions that the default profile is notnecessarily the profile named
default, which is subtle detail thatcan be confusing.
componentssection notes that the list is additive with theprofile's list of components.
targetsfield is now documented, previously it wasn't mentionedother than to say it's ignored with
path.