]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
rust: debugfs: Use kernel Atomic type in docs example
authorFUJITA Tomonori <fujita.tomonori@gmail.com>
Wed, 3 Dec 2025 00:04:11 +0000 (09:04 +0900)
committerDanilo Krummrich <dakr@kernel.org>
Mon, 19 Jan 2026 14:02:46 +0000 (15:02 +0100)
Switch the read_callback_file() documentation example from
core::sync::atomic::AtomicU32 to the kernel's Atomic because Rust
native atomics are not allowed to use in kernel.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
Reviewed-by: Boqun Feng <boqun.feng@gmail.com>
Link: https://patch.msgid.link/20251203000411.30434-1-fujita.tomonori@gmail.com
[ Use kernel vertical import style. - Danilo ]
Signed-off-by: Danilo Krummrich <dakr@kernel.org>
rust/kernel/debugfs.rs

index 513cc5750e63038d14b4e999a54f18351fd7d44d..d7b8014a6474698235203f2b7d8fec96f2bb43f8 100644 (file)
@@ -207,20 +207,25 @@ impl Dir {
     /// # Examples
     ///
     /// ```
-    /// # use core::sync::atomic::{AtomicU32, Ordering};
-    /// # use kernel::debugfs::Dir;
-    /// # use kernel::prelude::*;
+    /// # use kernel::{
+    /// #     debugfs::Dir,
+    /// #     prelude::*,
+    /// #     sync::atomic::{
+    /// #         Atomic,
+    /// #         Relaxed,
+    /// #     },
+    /// # };
     /// # let dir = Dir::new(c"foo");
     /// let file = KBox::pin_init(
     ///     dir.read_callback_file(c"bar",
-    ///     AtomicU32::new(3),
+    ///     Atomic::<u32>::new(3),
     ///     &|val, f| {
-    ///       let out = val.load(Ordering::Relaxed);
+    ///       let out = val.load(Relaxed);
     ///       writeln!(f, "{out:#010x}")
     ///     }),
     ///     GFP_KERNEL)?;
     /// // Reading "foo/bar" will show "0x00000003".
-    /// file.store(10, Ordering::Relaxed);
+    /// file.store(10, Relaxed);
     /// // Reading "foo/bar" will now show "0x0000000a".
     /// # Ok::<(), Error>(())
     /// ```