-
-
Notifications
You must be signed in to change notification settings - Fork 168
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
doc: Comparison to Ecosystem (including Rust std impl) [doc: 4/N] #1292
Conversation
299a9f7
to
979c131
Compare
b2ec5d5
to
2f42ea8
Compare
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 to lib.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.
6de3a05
to
89dceef
Compare
Nice! 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.
With ignore
there's a good chance the code will stop compiling over time (in fact currently it's missing a use uefi::println
). It's tricky to get no_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
to
b605167
Compare
This is especially interesting as the `std` implementation of Rust is upcoming.
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 |
This is split-out 4/N from #1264 to improve reviewability.
This:
lib.rs
so that readers know what to expect from the crateuefi
to other impls in the ecosystem, especially to thestd
impl for Ruststd
anduefi
Steps to Un-draft
Checklist