Skip to content

Commit 311ae06

Browse files
committed
doc: extend About section with Example Use Cases
1 parent 9f82985 commit 311ae06

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

uefi/src/lib.rs

+13-3
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,21 @@
2020
//! _Note that for producing EFI images, you also need to use a corresponding
2121
//! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
2222
//!
23-
//! # Interaction with uefi services
23+
//! ## Example Use Cases
2424
//!
2525
//! With this crate you can write code for the pre- and post-exit boot services
26-
//! epochs. However, the `uefi` crate unfolds its true potential when
27-
//! interacting with UEFI boot services.
26+
//! epochs. However, the `uefi` crate unfolds its true potential when crafting
27+
//! EFI images interacting with UEFI boot services and eventually exiting them.
28+
//!
29+
//! By EFI images (`image.efi`), we are referring to EFI applications, EFI
30+
//! boot service drivers, and EFI runtime service drivers. An EFI application
31+
//! might be your OS-specific loader technically similar to _GRUB_ or _Limine_.
32+
//!
33+
//! You can also use this crate to parse the UEFI memory map when a bootloader,
34+
//! such as _GRUB_ or _Limine_, passed the UEFI memory map as part of the
35+
//! corresponding boot information to your kernel, or to access runtime services
36+
//! from your kernel. Hence, when you also use utilize `uefi` also in ELF
37+
//! binaries and are not limited to EFI images.
2838
//!
2939
//! # Crate organisation
3040
//!

0 commit comments

Comments
 (0)