Skip to content

Commit cee3d77

Browse files
nicholasbishopphip1611
authored andcommitted
uefi-services: Add feature list to crate docstring
1 parent cc53255 commit cee3d77

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

uefi-services/src/lib.rs

+10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@
1414
//! Library code can simply use global UEFI functions
1515
//! through the reference provided by `system_table`.
1616
//!
17+
//! ## Optional crate features
18+
//!
19+
//! - `logger` (enabled by default): Initialize a global logger.
20+
//! - `panic_handler` (enabled by default): Register a panic handler. A
21+
//! panic handler must be provided for your program to compile, but
22+
//! you can choose to provide your own if you don't want to use this
23+
//! one.
24+
//! - `qemu`: On x86_64, make qemu exit with code 3 if a panic
25+
//! occurs. This feature assumes the program is running under QEMU.
26+
//!
1727
//! [`exit_boot_services`]: uefi::table::SystemTable::exit_boot_services
1828
1929
#![no_std]

0 commit comments

Comments
 (0)