Skip to content

Commit 5b083a3

Browse files
raccognicholasbishop
authored andcommitted
Fix documentation for BootServices::signal_event
1 parent b6af3ef commit 5b083a3

File tree

1 file changed

+1
-6
lines changed

1 file changed

+1
-6
lines changed

uefi/src/table/boot.rs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -717,12 +717,7 @@ impl BootServices {
717717
///
718718
/// This function directly calls the UEFI function `EFI_BOOT_SERVICES.SignalEvent()`.
719719
///
720-
/// Note: The UEFI Specification v2.9 states that this may only return `EFI_SUCCESS`, but,
721-
/// depending on the UEFI implementation, it is possible that this may return an error.
722-
/// More research should be done to determine if any UEFI implementations (specifically EDK2)
723-
/// return error codes for this function. To be safe, ensure that error codes are handled
724-
/// properly.
725-
///
720+
/// Currently, (as of UEFI Spec v2.9) this only returns `EFI_SUCCESS`.
726721
/// See the function definition in the UEFI Specification, Chapter 7.1 for more details.
727722
pub fn signal_event(&self, event: &Event) -> Result {
728723
// Safety: cloning this event should be safe, as we're directly passing it to firmware

0 commit comments

Comments
 (0)