Skip to content

Commit 2119a6e

Browse files
committed
rust: kernel: use # Examples consistently
In other words, the plural form, even if there is a single example. Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent 919ce3f commit 2119a6e

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

rust/kernel/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ impl<'a> Drop for KParamGuard<'a> {
194194

195195
/// Calculates the offset of a field from the beginning of the struct it belongs to.
196196
///
197-
/// # Example
197+
/// # Examples
198198
///
199199
/// ```
200200
/// # use kernel::prelude::*;
@@ -232,7 +232,7 @@ macro_rules! offset_of {
232232
/// as opposed to a pointer to another object of the same type. If this condition is not met,
233233
/// any dereference of the resulting pointer is UB.
234234
///
235-
/// # Example
235+
/// # Examples
236236
///
237237
/// ```
238238
/// # use kernel::container_of;

rust/kernel/module_param.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ macro_rules! impl_module_param {
210210
#[macro_export]
211211
/// Generate a static [`kernel_param_ops`](../../../include/linux/moduleparam.h) struct.
212212
///
213-
/// # Example
213+
/// # Examples
214214
/// ```ignore
215215
/// make_param_ops!(
216216
/// /// Documentation for new param ops.

rust/kernel/sync.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! This module contains the kernel APIs related to synchronisation that have been ported or
66
//! wrapped for usage by Rust code in the kernel and is shared by all of them.
77
//!
8-
//! # Example
8+
//! # Examples
99
//!
1010
//! ```
1111
//! # use kernel::mutex_init;

rust/kernel/sync/locked_by.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ use core::{cell::UnsafeCell, ops::Deref, ptr};
1515
/// [`LockedBy`] wraps the data in lieu of another locking primitive, and only allows access to it
1616
/// when the caller shows evidence that 'external' lock is locked.
1717
///
18-
/// # Example
18+
/// # Examples
1919
///
2020
/// The following is an example for illustrative purposes: `InnerDirectory::bytes_used` is an
2121
/// aggregate of all `InnerFile::bytes_used` and must be kept consistent; so we wrap `InnerFile` in

0 commit comments

Comments
 (0)