Commit 4bf7b97e authored by Patrick Miller's avatar Patrick Miller Committed by Miguel Ojeda
Browse files

rust: make section names plural 



Clean Rust documentation section headers to use plural names.

Suggested-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1110


Signed-off-by: default avatarPatrick Miller <paddymills@proton.me>
Link: https://lore.kernel.org/r/20241002022749.390836-1-paddymills@proton.me


[ Removed the `init` one that doesn't apply anymore and
  reworded slightly. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent eb71feaa

rust/kernel/list/arc.rs

+1 −1
Original line number Diff line number Diff line
@@ -464,7 +464,7 @@ impl<T, U, const ID: u64> core::ops::DispatchFromDyn<ListArc<U, ID>> for ListArc 


/// A utility for tracking whether a [`ListArc`] exists using an atomic.

///

/// # Invariant

/// # Invariants

///

/// If the boolean is `false`, then there is no [`ListArc`] for this value.

#[repr(transparent)]

rust/kernel/sync/arc.rs

+1 −1
Original line number Diff line number Diff line
@@ -492,7 +492,7 @@ fn from(item: Pin<UniqueArc<T>>) -> Self { 
/// There are no mutable references to the underlying [`Arc`], and it remains valid for the

/// lifetime of the [`ArcBorrow`] instance.

///

/// # Example

/// # Examples

///

/// ```

/// use kernel::sync::{Arc, ArcBorrow};

rust/macros/lib.rs

+1 −1
Original line number Diff line number Diff line
@@ -263,7 +263,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream { 
/// literals (lifetimes and documentation strings are not supported). There is a difference in

/// supported modifiers as well.

///

/// # Example

/// # Examples

///

/// ```

/// # const binder_driver_return_protocol_BR_OK: u32 = 0;