-
-
Notifications
You must be signed in to change notification settings - Fork 182
book: Rephrase target installation #1809
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
book: Rephrase target installation #1809
Conversation
|
I don't really have an opinion on this - @nicholasbishop any thoughts? |
|
@rymdbar Do you know of specific examples of OSes that provide rustc with the UEFI targets enabled in their packages? If so, then I don't mind updating the text here, but I don't want to change it without solid evidence that some distros (ideally major ones such as Debian) provide a way to install support for |
Funny that you should ask. There is this package for alpine, and the thing which brought rust-uefi to my attention was this merge request to bump rust to 1.91.0. Please note how the referenced diff adds an
Unfortunately Debian does not seem to provide libstd-rust-dev-uefi. Interestingly enough they do have libstd-rust-dev-wasm32 and even keep that one updated for trixie-backports. I have not done any extensive research on other operating systems or distributions, but would assume there are others carrying it. As the entire point of offering packaged software is to enable easy installation with native integration, controlled updates and all that comes with that. |
book/src/tutorial/building.md
Outdated
| easiest way to set this up is using a [rustup toolchain file]. In the root of | ||
| your repository, add `rust-toolchain.toml`: | ||
| In order to compile for UEFI, an appropriate target must be installed. Unless | ||
| your operating system provides up to date packages, the easiest way to set this |
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.
I think this should be rephrased since the important point isn't really whether the packages are up-to-date, it's whether the UEFI targets are packaged at all. Maybe something like:
| your operating system provides up to date packages, the easiest way to set this | |
| your operating system provides packages for the Rust UEFI targets, the easiest way to set this |
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.
Agreed. That suggested phrasing is even better. Thanks! I've force pushed the commit, updated to read that way.
1a77d39 to
7f31dcf
Compare
|
As follow-up information to anyone curious, the previously mentioned alpine rust bump to v1.91 got updated to link to this uefi-book before it got merged. Thanks! |
Minor rephrasing to make the modified section read true. This is helpful as it reminds some users of that there might be a more appropriate approach to installation, while being subtle enough to not disturb anyone.
Also, this makes it less problematic for operating system porters and distributors to add links to this book without opening up themselves to unnecessary support cases and bug reports.
The main rust installation instructions earlier in the book link to rust-lang.org:s installation instructions which do not have this problem, since they do mention other methods than rustup.
Checklist