Merge pull request #1391 from nicholasbishop/bishop-helper-init-doc

uefi: Add panic doc to uefi::helpers::init
rust-osdev · Sep 3, 2024 · 9090f9e · 9090f9e
2 parents f7ffd27 + 1cc3189
commit 9090f9e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/uefi/src/helpers/mod.rs b/uefi/src/helpers/mod.rs
@@ -55,6 +55,10 @@ pub fn system_table() -> SystemTable<Boot> {
 /// **PLEASE NOTE** that these helpers are meant for the pre exit boot service
 /// epoch. Limited functionality might work after exiting them, such as logging
 /// to the debugcon device.
+///
+/// # Panics
+///
+/// This function may panic if called more than once.
 #[allow(clippy::missing_const_for_fn)]
 pub fn init() -> Result<()> {
     // Set up logging.