Commit 6269fadf authored by Valentin Obst's avatar Valentin Obst Committed by Miguel Ojeda
Browse files

rust: kernel: add blank lines in front of code blocks 



Throughout the code base, blank lines are used before starting a code
block. Adapt outliers to improve consistency within the kernel crate.

Signed-off-by: default avatarValentin Obst <kernel@valentinobst.de>
Reviewed-by: default avatarTrevor Gross <tmgross@umich.edu>
Reviewed-by: default avatarMartin Rodriguez Reboredo <yakoyoku@gmail.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-9-0c8af94ed7de@valentinobst.de


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent af8b18d7

rust/kernel/types.rs

+3 −0
Original line number Diff line number Diff line
@@ -90,6 +90,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -> Self {} 
///

/// In the example below, we have multiple exit paths and we want to log regardless of which one is

/// taken:

///

/// ```

/// # use kernel::types::ScopeGuard;

/// fn example1(arg: bool) {
@@ -108,6 +109,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -> Self {} 
///

/// In the example below, we want to log the same message on all early exits but a different one on

/// the main exit path:

///

/// ```

/// # use kernel::types::ScopeGuard;

/// fn example2(arg: bool) {
@@ -129,6 +131,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -> Self {} 
///

/// In the example below, we need a mutable object (the vector) to be accessible within the log

/// function, so we wrap it in the [`ScopeGuard`]:

///

/// ```

/// # use kernel::types::ScopeGuard;

/// fn example3(arg: bool) -> Result {