Skip to content

Commit 5fd1081

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 2812468 commit 5fd1081

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

uefi/src/lib.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,24 @@
117117
//! Contributions in form of a PR are also highly welcome. Check our
118118
//! [contributing guide][contributing] for details.
119119
//!
120+
//! # Comparison to other Projects in the Ecosystem
121+
//!
122+
//! ## Rust `std` implementation
123+
//!
124+
//! There is an ongoing effort for a `std` [implementation of the Rust standard
125+
//! library](https://doc.rust-lang.org/nightly/rustc/platform-support/unknown-uefi.html),
126+
//! that is yet far from being mature. As of Mid-2024, we recommend to use our
127+
//! `uefi` library in a `no_std` binary to create EFI images.
128+
//!
129+
//! We will closely monitor the situation and update the documentation
130+
//! accordingly, once the `std` implementation is more mature.
131+
//!
132+
//! ## `r-efi`
133+
//!
134+
//! Raw UEFI bindings without high-level convenience similar to our `uefi-raw`
135+
//! crate, which is part of this project, but more feature-complete. It
136+
//! targets a lower-level than our `uefi` crate does.
137+
//!
120138
//! # MSRV
121139
//! <!-- Keep in Sync with README! -->
122140
//!

0 commit comments

Comments
 (0)