Skip to content

Commit 5466455

Browse files
authored
Merge pull request #1370 from nicholasbishop/bishop-update-mem-docs
uefi/mem: Update docs referring to BootServices
2 parents dc92697 + 468edca commit 5466455

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

uefi/src/mem/memory_map/impl_.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,10 +259,10 @@ impl IndexMut<usize> for MemoryMapRefMut<'_> {
259259
/// # Usage
260260
/// The type is intended to be used like this:
261261
/// 1. create it using [`MemoryMapBackingMemory::new`]
262-
/// 2. pass it to [`BootServices::get_memory_map`]
262+
/// 2. pass it to [`boot::get_memory_map`]
263263
/// 3. construct a [`MemoryMapOwned`] from it
264264
///
265-
/// [`BootServices::get_memory_map`]: crate::table::boot::BootServices::get_memory_map
265+
/// [`boot::get_memory_map`]: crate::boot::get_memory_map
266266
#[derive(Debug)]
267267
#[allow(clippy::len_without_is_empty)] // this type is never empty
268268
pub(crate) struct MemoryMapBackingMemory(NonNull<[u8]>);

uefi/src/mem/memory_map/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
//!
99
//! # Usecase: Obtain UEFI Memory Map
1010
//!
11-
//! You can use [`SystemTable::exit_boot_services`] or
12-
//! [`BootServices::memory_map`], which returns an properly initialized
11+
//! You can use [`boot::exit_boot_services`] or
12+
//! [`boot::memory_map`], which returns an properly initialized
1313
//! [`MemoryMapOwned`].
1414
//!
1515
//! # Usecase: Parse Memory Slice as UEFI Memory Map
@@ -28,8 +28,8 @@
2828
//! [`MemoryMapMeta`],
2929
//! - re-exports [`MemoryDescriptor`], [`MemoryType`], and [`MemoryAttribute`].
3030
//!
31-
//! [`SystemTable::exit_boot_services`]: uefi::table::SystemTable::exit_boot_services
32-
//! [`BootServices::memory_map`]: uefi::table::boot::BootServices::memory_map
31+
//! [`boot::exit_boot_services`]: crate::table::SystemTable::exit_boot_services
32+
//! [`boot::memory_map`]: crate::boot::memory_map
3333
3434
mod api;
3535
mod impl_;
@@ -49,7 +49,7 @@ impl Align for MemoryDescriptor {
4949
}
5050
}
5151

52-
/// A unique identifier of a UEFI memory map, used to tell the firmware that one
52+
/// A unique identifier of a UEFI memory map, used to tell the firmware that one
5353
/// has the latest valid memory map when exiting boot services.
5454
///
5555
/// If the memory map changes, due to any allocation or deallocation, this value

0 commit comments

Comments
 (0)