Skip to content

Commit 9c5d263

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 340e0d7 commit 9c5d263

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

uefi/src/lib.rs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,25 @@
118118
//! Contributions in form of a PR are also highly welcome. Check our
119119
//! [contributing guide][contributing] for details.
120120
//!
121+
//! # Comparison to other Projects in the Ecosystem
122+
//!
123+
//! ## Rust `std` implementation
124+
//!
125+
//! There is an ongoing effort for a `std` implementation of the Rust standard
126+
//! library. ([Platform description][rustc-uefi-std],
127+
//! [tracking issue][uefi-std-tr-issue]), that is yet far from being mature. As
128+
//! of Mid-2024, we recommend to use our `uefi` library in a `no_std` binary to
129+
//! create EFI images.
130+
//!
131+
//! We will closely monitor the situation and update the documentation
132+
//! accordingly, once the `std` implementation is more mature.
133+
//!
134+
//! ## `r-efi`
135+
//!
136+
//! Raw UEFI bindings without high-level convenience similar to our `uefi-raw`
137+
//! crate, which is part of this project, but more feature-complete. It
138+
//! targets a lower-level than our `uefi` crate does.
139+
//!
121140
//! # MSRV
122141
//! <!-- Keep in Sync with README! -->
123142
//!
@@ -157,6 +176,8 @@
157176
//! [spec]: https://uefi.org/specifications
158177
//! [unstable features]: https://doc.rust-lang.org/unstable-book/
159178
//! [uefirc]: https://github.com/codyd51/uefirc
179+
//! [rustc-uefi-std]: https://doc.rust-lang.org/nightly/rustc/platform-support/unknown-uefi.html
180+
//! [uefi-std-tr-issue]: https://github.com/rust-lang/rust/issues/100499
160181
161182
#![cfg_attr(all(feature = "unstable", feature = "alloc"), feature(allocator_api))]
162183
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

0 commit comments

Comments
 (0)