Skip to content

Commit 979c131

Browse files
committed
doc: add "Comparison to other Projects in the Ecosystem"
This is especially interesting as the `std` implementation of Rust is upcoming
1 parent 166f1b0 commit 979c131

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

uefi/src/lib.rs

+21
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,25 @@
109109
//! Contributions in form of a PR are also highly welcome. Check our
110110
//! [contributing guide][contributing] for details.
111111
//!
112+
//! # Comparison to other Projects in the Ecosystem
113+
//!
114+
//! ## Rust `std` implementation
115+
//!
116+
//! There is an ongoing effort for a `std` implementation of the Rust standard
117+
//! library. ([Platform description][rustc-uefi-std],
118+
//! [tracking issue][uefi-std-tr-issue]), that is yet far from being mature. As
119+
//! of Mid-2024, we recommend to use our `uefi` library in a `no_std` binary to
120+
//! create EFI images.
121+
//!
122+
//! We will closely monitor the situation and update the documentation
123+
//! accordingly, once the `std` implementation is more mature.
124+
//!
125+
//! ## `r-efi`
126+
//!
127+
//! Raw UEFI bindings without high-level convenience similar to our `uefi-raw`
128+
//! crate, which is part of this project, but more feature-complete. It
129+
//! targets a lower-level than our `uefi` crate does.
130+
//!
112131
//! # MSRV
113132
//! <!-- Keep in Sync with README! -->
114133
//!
@@ -151,6 +170,8 @@
151170
//! [spec]: https://uefi.org/specifications
152171
//! [unstable features]: https://doc.rust-lang.org/unstable-book/
153172
//! [uefirc]: https://github.com/codyd51/uefirc
173+
//! [rustc-uefi-std]: https://doc.rust-lang.org/nightly/rustc/platform-support/unknown-uefi.html
174+
//! [uefi-std-tr-issue]: https://github.com/rust-lang/rust/issues/100499
154175
155176
#![cfg_attr(all(feature = "unstable", feature = "alloc"), feature(allocator_api))]
156177
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

0 commit comments

Comments
 (0)