[docs+fmt] fix-up doc warnings (from CI) and set rustfmt edition (#749)

* [docs+fmt] fix-up doc warnings (from CI) and set rustfmt edition

The rustfmt.toml update is in line w/ omicron and other oxide
libraries/repositories and helpful for editors doing auto
cargo formatting (`cargo fmt`).

Author: zeeshanlakhani

crates/rgb-frame/src/lib.rs

@@ -61,7 +61,7 @@ impl Frame {
     /// contents initalized via the `populate` function.
     ///
     /// The responsibility is left to the caller to properly initalize the
-    /// entire [MaybeUninit<u8>] slice provided to the `populate` argument.  The
+    /// entire [`MaybeUninit<u8>`] slice provided to the `populate` argument.  The
     /// stride length of that buffer is provided as the second argument.
     pub fn new_uninit<F>(spec: Spec, populate: F) -> Self
     where
@@ -154,22 +154,22 @@ impl Frame {
 #[repr(u32)]
 #[strum(serialize_all = "UPPERCASE")]
 pub enum FourCC {
-    /// x:R:G:B [31:0] little endian
+    /// x:R:G:B `\[` 31:0 `\]` little endian
     XR24 = 0x34325258,
-    /// R:G:B:x [31:0] little endian
+    /// R:G:B:x `\[` 31:0 `\]` little endian
     RX24 = 0x34325852,
-    /// x:B:G:R [31:0] little endian
+    /// x:B:G:R `\[` 31:0 `\]` little endian
     XB24 = 0x34325842,
-    /// B:G:R:x [31:0] little endian
+    /// B:G:R:x `\[` 31:0 `\]` little endian
     BX24 = 0x34324258,
 
-    /// A:R:G:B [31:0] little endian
+    /// A:R:G:B `\[` 31:0 `\]` little endian
     AR24 = 0x34325241,
-    /// R:G:B:A [31:0] little endian
+    /// R:G:B:A `\[` 31:0 `\]` little endian
     RA24 = 0x34324152,
-    /// A:B:G:R [31:0] little endian
+    /// A:B:G:R `\[` 31:0 `\]` little endian
     AB24 = 0x34324142,
-    /// B:G:R:A [31:0] little endian
+    /// B:G:R:A `\[` 31:0 `\]` little endian
     BA24 = 0x34324241,
 }
 impl FourCC {

lib/propolis-client/src/support.rs

@@ -190,7 +190,7 @@ pub enum WSClientOffset {
 }
 
 /// This is a trivial abstraction wrapping the websocket connection returned
-/// by [crate::generated::Client::instance_serial], providing the additional
+/// by [crate::Client::instance_serial], providing the additional
 /// functionality of connecting to the new propolis-server when an instance
 /// is migrated (thus providing the illusion of the connection being
 /// seamlessly maintained through migration)

lib/propolis/src/cpuid.rs

@@ -116,7 +116,7 @@ impl From<Set> for Vec<bhyve_api::vcpu_cpuid_entry> {
     }
 }
 
-/// Convert a [vcpu_cpuid_entry](bhyve_api::vcpu_cpuid_entry) into an ([Ident],
+/// Convert a [vcpu_cpuid_entry] into an ([Ident],
 /// [Entry]) tuple, suitable for insertion into a [Set].
 ///
 /// This would be implemented as a [From] trait if rust let us.

lib/propolis/src/firmware/smbios/mod.rs

@@ -10,7 +10,7 @@ use table::{Table, Type127};
 mod bits;
 pub mod table;
 
-/// Collection of SMBIOS [table](table) instances, which will be rendered out
+/// Collection of SMBIOS [table] instances, which will be rendered out
 /// into two blocks of raw bytes representing the SMBIOS Entry Point and
 /// SMBIOS Structure Table.
 pub struct Tables {

lib/propolis/src/vmm/machine.rs

@@ -60,7 +60,7 @@ impl Machine {
     }
 
     /// Destroy the `Machine` and its associated resources.  Returns the
-    /// underlying [VmmHdl](crate::vmm::VmmHdl) for the caller to do further
+    /// underlying [VmmHdl] for the caller to do further
     /// cleanup, such as destroy the kernel VMM instance.
     pub fn destroy(mut self) -> Arc<VmmHdl> {
         self.do_destroy().expect("machine not already destroyed")

phd-tests/framework/src/disk/mod.rs

@@ -4,7 +4,7 @@
 
 //! Routines for creating and managing guest disks.
 //!
-//! Test cases create disks using the [`DiskFactory`] in their test contexts.
+//! Test cases create disks using the `DiskFactory` in their test contexts.
 //! They can then pass these disks to the VM factory to connect them to a
 //! specific guest VM.
 

phd-tests/framework/src/test_vm/mod.rs

@@ -132,7 +132,7 @@ enum VmState {
 }
 
 /// A virtual machine running in a Propolis server. Test cases create these VMs
-/// using the [`factory::VmFactory`] embedded in their test contexts.
+/// using the `factory::VmFactory` embedded in their test contexts.
 ///
 /// Once a VM has been created, tests will usually want to issue [`TestVm::run`]
 /// and [`TestVm::wait_to_boot`] calls so they can begin interacting with the

rustfmt.toml

@@ -3,3 +3,4 @@
 # ---------------------------------------------------------------------------
 max_width = 80
 use_small_heuristics = "max"
+edition = "2021"