Commit 6933c106 authored by Alban Kurti's avatar Alban Kurti Committed by Miguel Ojeda
Browse files

rust: init: add missing newline to pr_info! calls 



Several pr_info! calls in rust/kernel/init.rs (both in code examples
and macro documentation) were missing a newline, causing logs to
run together. This commit updates these calls to include a trailing
newline, improving readability and consistency with the C side.

Fixes: 6841d45a ("rust: init: add `stack_pin_init!` macro")
Fixes: 7f8977a7 ("rust: init: add `{pin_}chain` functions to `{Pin}Init<T, E>`")
Fixes: d0fdc396 ("rust: init: add `PinnedDrop` trait and macros")
Fixes: 4af84c6a ("rust: init: update expanded macro explanation")
Reported-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1139


Signed-off-by: default avatarAlban Kurti <kurti@invicto.ai>
Link: https://lore.kernel.org/r/20250206-printing_fix-v3-3-a85273b501ae@invicto.ai


[ Replaced Closes with Link since it fixes part of the issue. Added
  one more Fixes tag (still same set of stable kernels). - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 6f5c36f5

rust/kernel/init.rs

+6 −6
Original line number Diff line number Diff line
@@ -259,7 +259,7 @@ 
///     },

/// }));

/// let foo: Pin<&mut Foo> = foo;

/// pr_info!("a: {}", &*foo.a.lock());

/// pr_info!("a: {}\n", &*foo.a.lock());

/// ```

///

/// # Syntax
@@ -319,7 +319,7 @@ macro_rules! stack_pin_init { 
///     }, GFP_KERNEL)?,

/// }));

/// let foo = foo.unwrap();

/// pr_info!("a: {}", &*foo.a.lock());

/// pr_info!("a: {}\n", &*foo.a.lock());

/// ```

///

/// ```rust,ignore
@@ -352,7 +352,7 @@ macro_rules! stack_pin_init { 
///         x: 64,

///     }, GFP_KERNEL)?,

/// }));

/// pr_info!("a: {}", &*foo.a.lock());

/// pr_info!("a: {}\n", &*foo.a.lock());

/// # Ok::<_, AllocError>(())

/// ```

///
@@ -882,7 +882,7 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized { 
    ///

    /// impl Foo {

    ///     fn setup(self: Pin<&mut Self>) {

    ///         pr_info!("Setting up foo");

    ///         pr_info!("Setting up foo\n");

    ///     }

    /// }

    ///
@@ -986,7 +986,7 @@ pub unsafe trait Init<T: ?Sized, E = Infallible>: PinInit<T, E> { 
    ///

    /// impl Foo {

    ///     fn setup(&mut self) {

    ///         pr_info!("Setting up foo");

    ///         pr_info!("Setting up foo\n");

    ///     }

    /// }

    ///
@@ -1336,7 +1336,7 @@ fn write_pin_init<E>(mut self, init: impl PinInit<T, E>) -> Result<Pin<Self::Ini 
/// #[pinned_drop]

/// impl PinnedDrop for Foo {

///     fn drop(self: Pin<&mut Self>) {

///         pr_info!("Foo is being dropped!");

///         pr_info!("Foo is being dropped!\n");

///     }

/// }

/// ```

rust/kernel/init/macros.rs

+3 −3
Original line number Diff line number Diff line
@@ -45,7 +45,7 @@ 
//! #[pinned_drop]

//! impl PinnedDrop for Foo {

//!     fn drop(self: Pin<&mut Self>) {

//!         pr_info!("{self:p} is getting dropped.");

//!         pr_info!("{self:p} is getting dropped.\n");

//!     }

//! }

//!
@@ -412,7 +412,7 @@ 
//! #[pinned_drop]

//! impl PinnedDrop for Foo {

//!     fn drop(self: Pin<&mut Self>) {

//!         pr_info!("{self:p} is getting dropped.");

//!         pr_info!("{self:p} is getting dropped.\n");

//!     }

//! }

//! ```
@@ -423,7 +423,7 @@ 
//! // `unsafe`, full path and the token parameter are added, everything else stays the same.

//! unsafe impl ::kernel::init::PinnedDrop for Foo {

//!     fn drop(self: Pin<&mut Self>, _: ::kernel::init::__internal::OnlyCallFromDrop) {

//!         pr_info!("{self:p} is getting dropped.");

//!         pr_info!("{self:p} is getting dropped.\n");

//!     }

//! }

//! ```