Skip to content

Commit 950aa7b

Browse files
committed
doc: improve uefi::boot::memory_map() documentation
1 parent e5af016 commit 950aa7b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

uefi/src/boot.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -245,11 +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`].
249-
///
248+
/// and returns a [`MemoryMapOwned`].
249+
///
250250
/// The implementation tries to mitigate some UEFI pitfalls, such as getting
251251
/// the right allocation size for the memory map to prevent
252-
/// [`Status::BUFFER_TOO_SMALL`].
252+
/// [`Status::BUFFER_TOO_SMALL`].
253253
///
254254
/// # Parameters
255255
///
@@ -261,15 +261,15 @@ pub(crate) fn memory_map_size() -> MemoryMapMeta {
261261
///
262262
/// * [`Status::INVALID_PARAMETER`]: Invalid [`MemoryType`]
263263
/// * [`Status::OUT_OF_RESOURCES`]: allocation failed.
264-
///
264+
///
265265
/// # Panics
266-
///
266+
///
267267
/// Panics if the memory map can't be retrieved.
268268
pub fn memory_map(mt: MemoryType) -> Result<MemoryMapOwned> {
269269
let mut buffer = MemoryMapBackingMemory::new(mt)?;
270270

271271
let meta = get_memory_map(buffer.as_mut_slice());
272-
272+
273273
if let Err(e) = &meta {
274274
// We don't want to confuse users and let them think they should handle
275275
// this, as they can't do anything about it anyway.

0 commit comments

Comments
 (0)