[PATCH] rust: maple_tree: fix intra-doc link
Miguel Ojeda
ojeda at kernel.org
Wed Sep 10 07:02:12 PDT 2025
A couple `Occupied` intra-doc links are broken:
error: unresolved link to `Occupied`
--> rust/kernel/maple_tree.rs:96:46
|
96 | /// return an [`InsertError`] with the [`Occupied`] kind. It may also fail if memory
| ^^^^^^^^ no item named `Occupied` in scope
|
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
= note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
= help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
error: unresolved link to `Occupied`
--> rust/kernel/maple_tree.rs:135:36
|
135 | /// [`InsertError`] with the [`Occupied`] kind. It may also fail if memory allocation fails
| ^^^^^^^^ no item named `Occupied` in scope
|
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
Thus fix them.
Fixes: 7f51d867d2ed ("rust: maple_tree: add MapleTree")
Signed-off-by: Miguel Ojeda <ojeda at kernel.org>
---
Andrew: as usual, please feel free to rebase if that is what you
normally do, of course. This was in next-20250910. Thanks!
rust/kernel/maple_tree.rs | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/rust/kernel/maple_tree.rs b/rust/kernel/maple_tree.rs
index 31b6c13d08ef..e72eec56bf57 100644
--- a/rust/kernel/maple_tree.rs
+++ b/rust/kernel/maple_tree.rs
@@ -93,8 +93,7 @@ pub fn new() -> impl PinInit<Self> {
/// # Errors
///
/// If the maple tree already contains a range using the given index, then this call will
- /// return an [`InsertError`] with the [`Occupied`] kind. It may also fail if memory
- /// allocation fails.
+ /// return an [`InsertErrorKind::Occupied`]. It may also fail if memory allocation fails.
///
/// # Examples
///
@@ -132,8 +131,8 @@ pub fn insert(&self, index: usize, value: T, gfp: Flags) -> Result<(), InsertErr
/// # Errors
///
/// If the maple tree already contains an overlapping range, then this call will return an
- /// [`InsertError`] with the [`Occupied`] kind. It may also fail if memory allocation fails
- /// or if the requested range is invalid (e.g. empty).
+ /// [`InsertErrorKind::Occupied`]. It may also fail if memory allocation fails or if the
+ /// requested range is invalid (e.g. empty).
///
/// # Examples
///
base-commit: a3bff28df80b33386863823262550491155e896b
--
2.51.0
More information about the maple-tree
mailing list