diff options
| author | Patrick Miller <paddymills@proton.me> | 2024-10-02 05:28:48 +0300 |
|---|---|---|
| committer | Miguel Ojeda <ojeda@kernel.org> | 2025-05-26 19:03:09 +0300 |
| commit | 4bf7b97eb390f0a0730572101e0ce3367d31a770 (patch) | |
| tree | 788a28da26509cec195fe7c42314ee283d2a9cf7 | |
| parent | eb71feaacaaca227ae8f91c8578cf831553c5ab5 (diff) | |
| download | linux-4bf7b97eb390f0a0730572101e0ce3367d31a770.tar.xz | |
rust: make section names plural
Clean Rust documentation section headers to use plural names.
Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1110
Signed-off-by: Patrick 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: Miguel Ojeda <ojeda@kernel.org>
| -rw-r--r-- | rust/kernel/list/arc.rs | 2 | ||||
| -rw-r--r-- | rust/kernel/sync/arc.rs | 2 | ||||
| -rw-r--r-- | rust/macros/lib.rs | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/rust/kernel/list/arc.rs b/rust/kernel/list/arc.rs index a88a2dc65aa7..8401ddcd178a 100644 --- a/rust/kernel/list/arc.rs +++ b/rust/kernel/list/arc.rs @@ -464,7 +464,7 @@ where /// 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)] diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs index 356eef3afdae..c7af0aa48a0a 100644 --- a/rust/kernel/sync/arc.rs +++ b/rust/kernel/sync/arc.rs @@ -492,7 +492,7 @@ impl<T: ?Sized> From<Pin<UniqueArc<T>>> for Arc<T> { /// 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}; diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index cb429eceff71..b0b86fb9bfab 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -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; |