Skip to content

Commit b4d70be

Browse files
committed
uefi: improve doc
1 parent 55a0ba6 commit b4d70be

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

uefi/src/lib.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
//! the Rust standard library. For example, methods that return a
4949
//! `Vec` rather than filling a statically-sized array. This requires
5050
//! a global allocator; you can use the `global_allocator` feature or
51-
//! provide your own.
51+
//! provide your own. This is independent of internal direct usages of the
52+
//! UEFI boot service allocator which may happen anyway, where necessary.
5253
//! - `global_allocator`: Set [`allocator::Allocator`] as the global Rust
5354
//! allocator. This is a simple allocator that relies on the UEFI pool
5455
//! allocator. You can choose to provide your own allocator instead of

uefi/src/table/boot.rs

+6
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,12 @@ impl BootServices {
224224
/// Stores the current UEFI memory map in an UEFI-heap allocated buffer
225225
/// and returns a [`MemoryMap`].
226226
///
227+
/// # Parameters
228+
///
229+
/// - `mt`: The memory type for the backing memory on the UEFI heap.
230+
/// Usually, this is [`MemoryType::LOADER_DATA`]. You can also use a
231+
/// custom type.
232+
///
227233
/// # Errors
228234
///
229235
/// See section `EFI_BOOT_SERVICES.GetMemoryMap()` in the UEFI Specification

0 commit comments

Comments
 (0)