Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork175
doc: Comparison to Ecosystem (including Rust std impl) [doc: 4/N]#1292
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
299a9f7 to979c131Compareb2ec5d5 to2f42ea8CompareUh oh!
There was an error while loading.Please reload this page.
uefi/src/lib.rs Outdated
| //! to our `uefi-raw` crate, which is part of this project, but more | ||
| //! feature-complete. It targets a lower-level than our `uefi` crate does. | ||
| //! | ||
| //! # MSRV |
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.
The MSRV section was already added tolib.rs in a previous PR, so this can be dropped.
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.
Sorry, artifact from a big rebase - I missed that.
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.
The duplicate MSRV section is still present
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.
What?! How? I definitely removed that locally.
Sorry.. I really have no clue how this happened.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
6de3a05 to89dceefCompareNice! I will split the "rust-std-example" into a dedicated MR. Can you approve it in its current state, please? |
| //! Minimal example for an UEFI application using functionality of the | ||
| //! `uefi` crate: | ||
| //! | ||
| //! ```ignore |
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.
Withignore there's a good chance the code will stop compiling over time (in fact currently it's missing ause uefi::println). It's tricky to getno_std code compiling in a doc test, so how about linking to a file that is already tested by CI? Example:
//! ```ignore#![doc =include_str!("../../template/src/main.rs")]//! ```
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.
Oh, great idea! Thanks
3ce42be tob605167CompareThis is especially interesting as the `std` implementation of Rust is upcoming.
a07379eUh oh!
There was an error while loading.Please reload this page.
I'm very happy about the recent documentation additions, especially this one and#1331. This helps, I hope, to position ourself in the long term as the ones that define what is relevant, convenient and practical in UEFI with Rust and how the APIs should be designed, as |
Uh oh!
There was an error while loading.Please reload this page.
This is split-out 4/N from#1264 to improve reviewability.
This:
lib.rsso that readers know what to expect from the crateuefito other impls in the ecosystem, especially to thestdimpl for RuststdanduefiSteps to Un-draft
Checklist