-
Notifications
You must be signed in to change notification settings - Fork 926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update channel toolchain syntax #4074
Conversation
@djc - can I ask you a quick question about the <major.minor> form? I worked a bit on getting renovate to bump versions in the channel entry in override files: renovatebot/renovate#32432. Is it correct that <major.minor> indicates compatibility with any patch version and will resolve to the latest patch version? For example, 1.80 will resolve to 1.80.1 and not 1.80.0. |
I think how it works in rustup is that |
Thanks! Makes sense to me, it works like "stable" or "nightly" would but fixed to a particular minor version |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kyle-leonhard Sorry for the existing issue, but even our TOOLCHAIN_HELP
is out of date after #3858.
Now that we are here, would you mind updating both TOOLCHAIN_HELP
and this file accordingly, maybe in a separate commit or two, by adding the following to the mix?
1.80-beta
1.80-beta.1
11.80.0-beta
1.80.0-beta.1
You may add sub-rules such as <versioned> = <major.minor>|<major.minor.patch>
to simplify the writing.
Many thanks in advance!
Footnotes
-
Our parser accepts it, but it doesn't have a manifest2 yet. I think it wouldn't cause that much of a problem since other forms are not guaranteed to have a manifest either. ↩
-
To complete the context,
1.80
, for example, is the name of a certain manifest on the release server that can change from time to time. So on our side we just look for matching manifests on that server. If you are interested, you can refer to https://github.com/rust-lang/rust/pull/76107 for more details on this. ↩
@rami3l I added beta tags to both the toolchain and overrides documentation and the cli help. Can I take advantage of the goodwill to ask you a question? (feel free to reroute me). I was working on making renovate bump versions in the toolchain overrides file and a question came up: (pr).
Basically, it's convenient to use Github as a datasource for releases, to avoid doing the work to use the rust release servers. But it's important that releases being available on github mean the release is available for install. Does that make sense? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kyle-leonhard This is looking great!
There's just one small change before merging... Also, I think it's more reasonable to squash all these commits together and give it a proper message before it can be merged: something along the lines of docs: update channel toolchain syntax
would be fine.
@kyle-leonhard Let's continue this discussion under renovatebot/renovate#32432 (comment). |
f1d22b0
to
06da94c
Compare
Thanks @rami3l. Made the updates and squashed the commits |
Update documentation to match https://rust-lang.github.io/rustup/concepts/toolchains.html