Fix up rustdoc warnings

Author: pfmooney

crates/cpuid-utils/src/lib.rs

@@ -475,7 +475,7 @@ impl CpuidSet {
     }
 
     /// Returns `Ok` if `self` is equivalent to `other`; if not, returns a
-    /// [`CpuidMapMismatch`] describing the first observed difference between
+    /// [`CpuidSetMismatch`] describing the first observed difference between
     /// the two sets.
     pub fn is_equivalent_to(
         &self,

lib/propolis-client/src/lib.rs

@@ -13,10 +13,11 @@
 /// "manual" impls of things that Progenitor would otherwise derive).
 ///
 /// In the generated client, the native "top-level" instance spec and component
-/// types ([`VersionedInstanceSpec`], [`InstanceSpecV0`], and
-/// [`ReplacementComponent`]) replace their generated counterparts. This
-/// obviates the need to maintain `From` impls to convert between native and
-/// generated types.
+/// types ([`crate::instance_spec::VersionedInstanceSpec`],
+/// [`crate::instance_spec::InstanceSpecV0`], and
+/// [`crate::instance_spec::ReplacementComponent`]) replace their generated
+/// counterparts. This obviates the need to maintain `From` impls to convert
+/// between native and generated types.
 pub mod instance_spec {
     pub use propolis_api_types::instance_spec::{
         components::{backends::*, board::*, devices::*},

lib/propolis/src/block/mod.rs

@@ -279,9 +279,9 @@ pub trait Backend: Send + Sync + 'static {
     /// requests while paused and resume issuing them when they are resumed.
     ///
     /// WARNING: The caller may abort VM startup and cancel the future created
-    /// by this routine. In this case the caller may not call [`stop`] prior to
-    /// dropping the backend. This routine is, however, guaranteed to be called
-    /// before the VM's vCPUs are started.
+    /// by this routine. In this case the caller may not call [`Self::stop()`]
+    /// prior to dropping the backend. This routine is, however, guaranteed to
+    /// be called before the VM's vCPUs are started.
     async fn start(&self) -> anyhow::Result<()>;
 
     /// Stop attempting to process new [Request]s from [Device] (if attached)

lib/propolis/src/block/tracking.rs

@@ -39,8 +39,7 @@ impl<T> CompletionCallback for T where
 /// use will be missing calls into those probes.
 ///
 /// Each [`Tracking`] also allows one optional callback that it will call
-/// whenever an I/O is completed. This can be set in the
-/// [`Tracking::with_completion_callback()`] constructor, or with
+/// whenever an I/O is completed. This can be set via
 /// [`Tracking::set_completion_callback()`].
 pub struct Tracking<T> {
     inner: Mutex<TrackingInner<T>>,

lib/propolis/src/cpuid.rs

@@ -13,8 +13,8 @@ use std::ops::Bound;
 use bhyve_api::vcpu_cpuid_entry;
 use cpuid_utils::{CpuidIdent, CpuidMap, CpuidSet, CpuidValues, CpuidVendor};
 
-/// Convert a [vcpu_cpuid_entry] into an ([CpuidLeaf],
-/// [CpuidValues]) tuple, suitable for insertion into a [Set].
+/// Convert a [vcpu_cpuid_entry] into an ([CpuidIdent],
+/// [CpuidValues]) tuple, suitable for insertion into a [CpuidSet].
 ///
 /// This would be implemented as a [From] trait if rust let us.
 pub fn from_raw(
@@ -74,7 +74,7 @@ impl Specializer {
         Self { vcpuid: Some(vcpuid), ..self }
     }
 
-    /// Specify CPU topology types to render into the specialized [Set]
+    /// Specify CPU topology types to render into the specialized [CpuidSet]
     ///
     /// Without basic information such as the number of vCPUs (set by
     /// [`Self::with_vcpu_count()`]), population of the requested topology
@@ -92,7 +92,7 @@ impl Specializer {
         Self { cpu_topo_populate, ..self }
     }
 
-    /// Specify CPU topology types to clear from the specialized [Set]
+    /// Specify CPU topology types to clear from the specialized [CpuidSet]
     ///
     /// Some leafs in the provided set may not match expectations for the given
     /// CPU vendor.  Without populating it with generated data (via
@@ -113,7 +113,7 @@ impl Specializer {
     }
 
     /// Given the attributes and modifiers specified in this [Specializer],
-    /// render an updated [Set] reflecting those data.
+    /// render an updated [CpuidSet] reflecting those data.
     pub fn execute(
         self,
         mut set: CpuidSet,

lib/propolis/src/enlightenment/hyperv/mod.rs

@@ -8,11 +8,11 @@
 //! implement the hypervisor described in Microsoft's Hypervisor Top-Level
 //! Functional Specification (TLFS). The behavior in this module is based on
 //! version 6.0b of the TLFS, which is available on GitHub:
-//! https://github.com/MicrosoftDocs/Virtualization-Documentation/blob/main/tlfs/Hypervisor%20Top%20Level%20Functional%20Specification%20v6.0b.pdf
+//! <https://github.com/MicrosoftDocs/Virtualization-Documentation/blob/main/tlfs/Hypervisor%20Top%20Level%20Functional%20Specification%20v6.0b.pdf>
 //!
 //! Microsoft also maintains a list of minimum requirements for any hypervisor
 //! that intends to implement a Hyper-V-compatible interface:
-//! https://github.com/MicrosoftDocs/Virtualization-Documentation/blob/main/tlfs/Requirements%20for%20Implementing%20the%20Microsoft%20Hypervisor%20Interface.pdf
+//! <https://github.com/MicrosoftDocs/Virtualization-Documentation/blob/main/tlfs/Requirements%20for%20Implementing%20the%20Microsoft%20Hypervisor%20Interface.pdf>
 
 use std::sync::{Arc, Mutex, OnceLock};