Skip to content

Commit 944f142

Browse files
committed
doc: extend About section with Example Use Cases
1 parent 58fb9b2 commit 944f142

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

uefi/src/lib.rs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,21 @@
2929
//! _Note that for producing EFI images, you also need to use a corresponding
3030
//! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
3131
//!
32-
//! # Interaction with uefi services
32+
//! ## Example Use Cases
3333
//!
3434
//! With this crate you can write code for the pre- and post-exit boot services
35-
//! epochs. However, the `uefi` crate unfolds its true potential when
36-
//! interacting with UEFI boot services.
35+
//! epochs. However, the `uefi` crate unfolds its true potential when crafting
36+
//! EFI images interacting with UEFI boot services and eventually exiting them.
37+
//!
38+
//! By EFI images (`image.efi`), we are referring to EFI applications, EFI
39+
//! boot service drivers, and EFI runtime service drivers. An EFI application
40+
//! might be your OS-specific loader technically similar to _GRUB_ or _Limine_.
41+
//!
42+
//! You can also use this crate to parse the UEFI memory map when a bootloader,
43+
//! such as _GRUB_ or _Limine_, passed the UEFI memory map as part of the
44+
//! corresponding boot information to your kernel, or to access runtime services
45+
//! from your kernel. Hence, when you also use utilize `uefi` also in ELF
46+
//! binaries and are not limited to EFI images.
3747
//!
3848
//! # Crate organisation
3949
//!

0 commit comments

Comments
 (0)