[v6,24/26] rust: alloc: update module comment of alloc.rs

Commit Message

Danilo Krummrich Aug. 16, 2024, 12:11 a.m. UTC

Before we remove Rust's alloc crate, rewrite the module comment in
alloc.rs to avoid a rustdoc warning.

Besides that, the module comment in alloc.rs isn't correct anymore,
we're no longer extending Rust's alloc crate.

Reviewed-by: Alice Ryhl <[e-mail]>
Reviewed-by: Benno Lossin <[e-mail]>
Signed-off-by: Danilo Krummrich <[e-mail]>
---
 rust/kernel/alloc.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Patch

diff --git a/rust/kernel/alloc.rs b/rust/kernel/alloc.rs
index 5c66229a7542..282afd184957 100644
--- a/rust/kernel/alloc.rs
+++ b/rust/kernel/alloc.rs
@@ -1,6 +1,6 @@ 
 // SPDX-License-Identifier: GPL-2.0
 
-//! Extensions to the [`alloc`] crate.
+//! Implementation of the kernel's memory allocation infrastructure.
 
 #[cfg(not(any(test, testlib)))]
 pub mod allocator;