Skip to content

Commit 3dcb3a9

Browse files
committed
doc: improve uefi::boot::memory_map() documentation
1 parent 7c5afc2 commit 3dcb3a9

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

uefi/src/boot.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,11 @@ pub(crate) fn memory_map_size() -> MemoryMapMeta {
245245
}
246246

247247
/// Stores the current UEFI memory map in an UEFI-heap allocated buffer
248-
/// and returns a [`MemoryMapOwned`].
248+
/// and returns a [`MemoryMapOwned`].
249+
///
250+
/// The implementation tries to mitigate some UEFI pitfalls, such as getting
251+
/// the right allocation size for the memory map. Therefore, a return value of
252+
/// [`Status::BUFFER_TOO_SMALL`] should be treated as unrecoverable error.
249253
///
250254
/// # Parameters
251255
///

0 commit comments

Comments
 (0)