Fix remaining lint error.

Some comments need to flow with the proper indentation. Signed-off-by: Dionna Glaze <[email protected]>
coconut-svsm · Jul 26, 2024 · 11ca444 · 11ca444
1 parent bb9eeab
commit 11ca444
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/elf/src/relocation.rs b/elf/src/relocation.rs
@@ -129,8 +129,8 @@ pub trait Elf64RelocProcessor {
     /// # Returns
     ///
     /// - [`Result<Elf64RelocOp, ElfError>`]: A [`Result`] containing the
-    /// relocation operation ([`Elf64RelocOp`]) if successful, or an [`ElfError`] if
-    /// there was an issue applying the relocation.
+    ///   relocation operation ([`Elf64RelocOp`]) if successful, or an [`ElfError`] if
+    ///   there was an issue applying the relocation.
     fn apply_relocation(
         &self,
         rela: &Elf64Rela,
@@ -181,8 +181,8 @@ impl Elf64RelocProcessor for Elf64X86RelocProcessor {
     /// # Returns
     ///
     /// - [`Result<Elf64RelocOp, ElfError>`]: A [`Result`] containing the relocation
-    /// operation ([`Elf64RelocOp`]) if successful, or an [`ElfError`] if there was an
-    /// issue applying the relocation.
+    ///   operation ([`Elf64RelocOp`]) if successful, or an [`ElfError`] if there was an
+    ///   issue applying the relocation.
     fn apply_relocation(
         &self,
         rela: &Elf64Rela,

diff --git a/kernel/src/fs/api.rs b/kernel/src/fs/api.rs
@@ -98,7 +98,7 @@ pub trait File: Debug + Send + Sync {
     ///  # Arguments
     ///
     ///  - `size`: specifies the size in bytes to which the file
-    ///  is to be truncated.
+    ///    is to be truncated.
     ///
     ///  # Returns
     ///

diff --git a/kernel/src/fs/filesystem.rs b/kernel/src/fs/filesystem.rs
@@ -118,7 +118,7 @@ impl FileHandle {
     ///  # Arguments
     ///
     ///  - `offset`: specifies the size in bytes to which the file
-    ///  is to be truncated.
+    ///     git  is to be truncated.
     ///
     ///  # Returns
     ///
@@ -172,7 +172,7 @@ impl SvsmFs {
     /// # Arguments
     ///
     /// - `root`: represents directory which is to be set
-    /// as the root of the filesystem.
+    ///   as the root of the filesystem.
     fn initialize(&mut self, root: &Arc<RamDirectory>) {
         assert!(!self.initialized());
         self.root = Some(root.clone());

diff --git a/kernel/src/insn_decode/decode.rs b/kernel/src/insn_decode/decode.rs
@@ -383,8 +383,8 @@ impl DecodedInsnCtx {
     ///
     /// * `bytes` - The raw bytes of the instruction to be decoded.
     /// * `mctx` - A reference to an object implementing the
-    /// `InsnMachineCtx` trait to provide the necessary machine context
-    /// for decoding.
+    ///   `InsnMachineCtx` trait to provide the necessary machine context
+    ///   for decoding.
     ///
     ///  # Returns
     ///

diff --git a/kernel/src/insn_decode/opcode.rs b/kernel/src/insn_decode/opcode.rs
@@ -202,7 +202,7 @@ impl OpCodeDesc {
     /// # Arguments
     ///
     /// * `insn` - A mutable reference to the `OpCodeBytes` representing
-    /// the bytes of the opcode to be decoded.
+    ///   the bytes of the opcode to be decoded.
     ///
     /// # Returns
     ///