Skip to contentSkip to conversation

rust: impl_flags: use bit helper in example

PATCH Applied Kosumi Chan 3 participants 4 messages Jul 11 – Aug 10 Rust

lore
Share & tools
lore

Kosumi Chan

author
#0 lore raw

PATCH v2 1/1 rust: impl_flags: use bit helper in example

Use bit_u32() instead of open-coding shifts in the impl_flags! example. This demonstrates the checked bit helper and ensures that bit positions remain within the underlying u32 type.

Suggested-by Miguel Ojeda <[email protected]>
Link https://github.com/Rust-for-Linux/linux/issues/1244
Assisted-by OpenCode:openai/gpt-5.6-sol
Signed-off-by Kosumi Chan <[email protected]>

---
Changes in v2:
- Use a full name for the author and Signed-off-by identities.

v1: https://lore.kernel.org/rust-for-linux/[email protected]/

 rust/kernel/impl_flags.rs | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
rust/kernel/impl_flags.rs +7 -4
index e2bd7639d..fdf44d5ee 100644
@@ -19,7 +19,10 @@
 /// # Examples
 ///
 /// ```
-/// use kernel::impl_flags;
+/// use kernel::{
+///     bits::bit_u32,
+///     impl_flags, //
+/// };
 ///
 /// impl_flags!(
 ///     /// Represents multiple permissions.

@@ -30,13 +33,13 @@
 ///     #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 ///     pub enum Permission {
 ///         /// Read permission.
-///         Read = 1 << 0,
+///         Read = bit_u32(0),
 ///
 ///         /// Write permission.
-///         Write = 1 << 1,
+///         Write = bit_u32(1),
 ///
 ///         /// Execute permission.
-///         Execute = 1 << 2,
+///         Execute = bit_u32(2),
 ///     }
 /// );
 ///

base-commit: dc59e4fea9d83f03bad6bddf3fa2e52491777482

Signature · 1 line
2.54.0
#1 lore raw
Quoted 9 lines · Kosumi Chan

Use bit_u32() instead of open-coding shifts in the impl_flags! example. This demonstrates the checked bit helper and ensures that bit positions remain within the underlying u32 type.

Suggested-by Miguel Ojeda <[email protected]>
Link https://github.com/Rust-for-Linux/linux/issues/1244
Assisted-by OpenCode:openai/gpt-5.6-sol
Signed-off-by Kosumi Chan <[email protected]>

Looks fine, thanks.

I think I will add:

Suggested-by Greg Kroah-Hartman <[email protected]>
Link https://lore.kernel.org/rust-for-linux/2026071054-hazing-antirust-8e40@gregkh/ open here

since Greg suggested the original change/idea even if not the one here.

Cheers,
Miguel

reviewer Reviewed-by on v2 1/1
#2 lore raw
In reply to Kosumi Chan
Quoted 8 lines · Kosumi Chan

Use bit_u32() instead of open-coding shifts in the impl_flags! example. This demonstrates the checked bit helper and ensures that bit positions remain within the underlying u32 type.

Suggested-by Miguel Ojeda <[email protected]>
Link https://github.com/Rust-for-Linux/linux/issues/1244
Assisted-by OpenCode:openai/gpt-5.6-sol
Signed-off-by Kosumi Chan <[email protected]>

Why not. :)

Reviewed-by Alexandre Courbot <[email protected]>
Applied
#3 lore raw
In reply to Kosumi Chan
Quoted 9 lines · Kosumi Chan

Use bit_u32() instead of open-coding shifts in the impl_flags! example. This demonstrates the checked bit helper and ensures that bit positions remain within the underlying u32 type.

Suggested-by Miguel Ojeda <[email protected]>
Link https://github.com/Rust-for-Linux/linux/issues/1244
Assisted-by OpenCode:openai/gpt-5.6-sol
Signed-off-by Kosumi Chan <[email protected]>

Applied to rust-next -- thanks everyone!

Cheers,
Miguel