Skip to content

Commit 2b45e46

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

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

uefi/src/boot.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,10 @@ pub(crate) fn memory_map_size() -> MemoryMapMeta {
248248
/// and returns a [`MemoryMapOwned`].
249249
///
250250
/// 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.
251+
/// the right allocation size for the memory map to prevent
252+
/// [`Status::BUFFER_TOO_SMALL`]. If [`Status::BUFFER_TOO_SMALL`] is returned,
253+
/// further calls are likely to fail as well. If so, the situation may be
254+
/// considered as unrecoverable error.
253255
///
254256
/// # Parameters
255257
///

0 commit comments

Comments
 (0)