Skip to content

Commit 42eb20d

Browse files
authored
Merge pull request #1373 from nicholasbishop/bishop-loaded-image-docs
uefi: Update LoadedImage protocol docs
2 parents 3be4d04 + 50df766 commit 42eb20d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

uefi/src/proto/loaded_image.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,14 @@ impl LoadedImage {
139139
/// Drivers that wish to support unloading have to register their unload handler
140140
/// using this protocol. It is responsible for cleaning up any resources the
141141
/// image is using before returning. Unloading a driver is done with
142-
/// [`BootServices::unload_image`].
142+
/// [`boot::unload_image`].
143143
///
144144
/// # Safety
145145
///
146146
/// Only the driver that this [`LoadedImage`] is attached to should register an
147147
/// unload handler.
148148
///
149-
/// [`BootServices::unload_image`]: crate::table::boot::BootServices
149+
/// [`boot::unload_image`]: crate::boot::unload_image
150150
pub unsafe fn set_unload(
151151
&mut self,
152152
unload: extern "efiapi" fn(image_handle: Handle) -> Status,
@@ -157,7 +157,7 @@ impl LoadedImage {
157157
}
158158

159159
/// Set the load options for the image. This can be used prior to
160-
/// calling `BootServices.start_image` to control the command line
160+
/// calling [`boot::start_image`] to control the command line
161161
/// passed to the image.
162162
///
163163
/// `size` is in bytes.
@@ -167,6 +167,8 @@ impl LoadedImage {
167167
/// This function takes `options` as a raw pointer because the
168168
/// load options data is not owned by `LoadedImage`. The caller
169169
/// must ensure that the memory lives long enough.
170+
///
171+
/// [`boot::start_image`]: crate::boot::start_image
170172
pub unsafe fn set_load_options(&mut self, options: *const u8, size: u32) {
171173
self.0.load_options = options.cast();
172174
self.0.load_options_size = size;

0 commit comments

Comments
 (0)