Skip to content

Commit 0276eec

Browse files
committed
doc: extend About section with Example Use Cases
1 parent 1ff594b commit 0276eec

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
@@ -23,11 +23,21 @@
2323
//! _Note that for producing EFI images, you also need to use a corresponding
2424
//! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
2525
//!
26-
//! # Interaction with uefi services
26+
//! ## Example Use Cases
2727
//!
2828
//! With this crate you can write code for the pre- and post-exit boot services
29-
//! epochs. However, the `uefi` crate unfolds its true potential when
30-
//! interacting with UEFI boot services.
29+
//! epochs. However, the `uefi` crate unfolds its true potential when crafting
30+
//! EFI images interacting with UEFI boot services and eventually exiting them.
31+
//!
32+
//! By EFI images (`image.efi`), we are referring to EFI applications, EFI
33+
//! boot service drivers, and EFI runtime service drivers. An EFI application
34+
//! might be your OS-specific loader technically similar to _GRUB_ or _Limine_.
35+
//!
36+
//! You can also use this crate to parse the UEFI memory map when a bootloader,
37+
//! such as _GRUB_ or _Limine_, passed the UEFI memory map as part of the
38+
//! corresponding boot information to your kernel, or to access runtime services
39+
//! from your kernel. Hence, when you also use utilize `uefi` also in ELF
40+
//! binaries and are not limited to EFI images.
3141
//!
3242
//! # Crate organisation
3343
//!

0 commit comments

Comments
 (0)