misc(docs): cleanup

Signed-off-by: Anhad Singh <[email protected]>

Author: Andy-Python-Programmer

src/aero_kernel/src/arch/x86_64/apic.rs

@@ -288,11 +288,11 @@ impl LocalApic {
     /// This function works for both XAPIC and X2APIC.
     ///
     /// ## Safety
-    /// * The provided `register` must be a valid APIC register and the `value` must
-    /// be a valid value for the provided APIC register.
+    /// * The provided `register` must be a valid APIC register and the `value` must be a valid
+    ///   value for the provided APIC register.
     ///
-    /// * If the `register` is 64-bit wide, then the [`Self::write_long`] function must
-    /// be used instead.
+    /// * If the `register` is 64-bit wide, then the [`Self::write_long`] function must be used
+    ///   instead.
     unsafe fn write(&mut self, register: u32, value: u32) {
         match self.apic_type {
             ApicType::X2apic => {

src/aero_kernel/src/arch/x86_64/controlregs.rs

@@ -335,19 +335,17 @@ pub unsafe fn write_xcr0(value: XCr0Flags) {
 /// Write the given set of CR4 flags.
 ///
 /// ## Safety
-/// - This function does not preserve the current value of the CR4 flags and
-/// reserved fields.
-/// - Its possible to violate memory safety by swapping CR4 flags.
+/// * This function does not preserve the current value of the CR4 flags and reserved fields.
+/// * Its possible to violate memory safety by swapping CR4 flags.
 pub unsafe fn write_cr4(value: Cr4Flags) {
     asm!("mov cr4, {}", in(reg) value.bits(), options(nostack, preserves_flags));
 }
 
 /// Write the given set of CR0 flags.
 ///
 /// ## Safety
-/// - This function does not preserve the current value of the CR0 flags and
-/// reserved fields.
-/// - Its possible to violate memory safety by swapping CR0 flags.
+/// * This function does not preserve the current value of the CR0 flags and reserved fields.
+/// * Its possible to violate memory safety by swapping CR0 flags.
 pub unsafe fn write_cr0(value: Cr0Flags) {
     asm!("mov cr0, {}", in(reg) value.bits(), options(nostack, preserves_flags));
 }

src/aero_kernel/src/cmdline.rs

@@ -126,8 +126,7 @@ pub fn parse(cmdline: &'static str, modules: &[&File]) -> CommandLine {
 /// Returns the raw kernel command line string.
 ///
 /// ## Panics
-/// * If this function was invoked before the kernel command line was
-/// parsed using [`self::parse`].
+/// * If this function was invoked before the kernel command line was parsed using [`self::parse`].
 pub fn get_raw_cmdline() -> &'static str {
     RAW_CMDLINE_STR
         .get()

src/aero_kernel/src/rendy.rs

@@ -17,10 +17,10 @@
 
 use core::fmt::Write;
 
+use core::fmt;
 use core::ops::{Index, IndexMut};
 use core::ptr::NonNull;
 use core::time::Duration;
-use core::{fmt, u8};
 
 use alloc::boxed::Box;
 

src/aero_kernel/src/userland/signals.rs

@@ -395,12 +395,9 @@ impl Signals {
     /// Used to update or read the signal mask of a task.
     ///
     /// ## Notes
-    /// * If `old_set` is not `None`, the previous value of the signal mask is
-    /// stored in oldset.
-    ///
-    /// * If `set` is `None`, then the signal mask is unchanged (i.e., `how` is
-    /// ignored), but the current value of the signal mask is returned in `old_set`
-    /// (if it is not `None`).
+    /// * If `old_set` is not `None`, the previous value of the signal mask is stored in oldset.
+    /// * If `set` is `None`, then the signal mask is unchanged (i.e., `how` is ignored), but the
+    ///   current value of the signal mask is returned in `old_set` (if it is not `None`).
     pub fn set_mask(&self, how: SigProcMask, set: Option<u64>, old_set: Option<&mut u64>) {
         if let Some(old) = old_set {
             *old = self.blocked_mask.load(Ordering::SeqCst);