Merge pull request #1377 from nicholasbishop/bishop-more-doc-updates

uefi: Remove BootServices from more docstrings

Author: nicholasbishop

uefi/src/boot.rs

@@ -4,7 +4,7 @@
 //!
 //! # Accessing protocols
 //!
-//! Protocols can be opened using several methods of `BootServices`. Most
+//! Protocols can be opened using several functions in this module. Most
 //! commonly, [`open_protocol_exclusive`] should be used. This ensures that
 //! nothing else can use the protocol until it is closed, and returns a
 //! [`ScopedProtocol`] that takes care of closing the protocol when it is
@@ -1510,7 +1510,7 @@ impl Drop for TplGuard {
 // TestProtocol (0x04) excluded because it doesn't actually open the
 // protocol, just tests if it's present on the handle. Since that
 // changes the interface significantly, that's exposed as a separate
-// method: `BootServices::test_protocol`.
+// method: `test_protocol`.
 
 /// Attributes for [`open_protocol`].
 #[repr(u32)]

uefi/src/data_types/mod.rs

@@ -70,9 +70,11 @@ impl Event {
     /// Clone this `Event`
     ///
     /// # Safety
-    /// When an event is closed by calling `BootServices::close_event`, that event and ALL references
+    /// When an event is closed by calling [`boot::close_event`], that event and ALL references
     /// to it are invalidated and the underlying memory is freed by firmware. The caller must ensure
     /// that any clones of a closed `Event` are never used again.
+    ///
+    /// [`boot::close_event`]: crate::boot::close_event
     #[must_use]
     pub const unsafe fn unsafe_clone(&self) -> Self {
         Self(self.0)

uefi/src/lib.rs

@@ -203,7 +203,6 @@
 //! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
 //! [UEFI]: https://uefi.org/
 //! [Zulip]: https://rust-osdev.zulipchat.com
-//! [`BootServices`]: table::boot::BootServices
 //! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc
 //! [`SystemTable`]: table::SystemTable
 //! [`ctr16!`]: crate::cstr16

uefi/src/proto/device_path/mod.rs

@@ -812,7 +812,7 @@ pub enum NodeConversionError {
 ///
 /// The layout of this type is the same as a [`DevicePath`].
 ///
-/// [`load_image`]: crate::table::boot::BootServices::load_image
+/// [`load_image`]: crate::boot::load_image
 #[repr(transparent)]
 #[unsafe_protocol("bc62157e-3e33-4fec-9920-2d3b36d750df")]
 #[derive(Debug, Pointee)]