tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Patrick Miller and committed by
Miguel Ojeda 4bf7b97e eb71feaa

+3 -3
+1 -1
rust/kernel/list/arc.rs
··· 464 464 465 465 /// A utility for tracking whether a [`ListArc`] exists using an atomic. 466 466 /// 467 - /// # Invariant 467 + /// # Invariants 468 468 /// 469 469 /// If the boolean is `false`, then there is no [`ListArc`] for this value. 470 470 #[repr(transparent)]
+1 -1
rust/kernel/sync/arc.rs
··· 492 492 /// There are no mutable references to the underlying [`Arc`], and it remains valid for the 493 493 /// lifetime of the [`ArcBorrow`] instance. 494 494 /// 495 - /// # Example 495 + /// # Examples 496 496 /// 497 497 /// ``` 498 498 /// use kernel::sync::{Arc, ArcBorrow};
+1 -1
rust/macros/lib.rs
··· 263 263 /// literals (lifetimes and documentation strings are not supported). There is a difference in 264 264 /// supported modifiers as well. 265 265 /// 266 - /// # Example 266 + /// # Examples 267 267 /// 268 268 /// ``` 269 269 /// # const binder_driver_return_protocol_BR_OK: u32 = 0;