Skip to content

Commit f56888a

Browse files
raccognicholasbishop
authored andcommitted
Add documentation links for SimpleFileSystem.
Adds documentation for #416
1 parent af7ae50 commit f56888a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/proto/media/fs.rs

+10
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ use core::ptr;
99
///
1010
/// This interface is implemented by some storage devices
1111
/// to allow file access to the contained file systems.
12+
///
13+
/// # Accessing `SimpleFileSystem` protocol
14+
///
15+
/// Use [`BootServices::get_image_file_system`] to retrieve the `SimpleFileSystem`
16+
/// protocol associated with a given image handle.
17+
///
18+
/// See the [`BootServices`] documentation for more details of how to open a protocol.
19+
///
20+
/// [`BootServices::get_image_file_system`]: crate::table::boot::BootServices::get_image_file_system
21+
/// [`BootServices`]: crate::table::boot::BootServices#accessing-protocols
1222
#[repr(C)]
1323
#[unsafe_guid("964e5b22-6459-11d2-8e39-00a0c969723b")]
1424
#[derive(Protocol)]

0 commit comments

Comments
 (0)