rust: maple_tree: fix intra-doc link
Subsystems (3)
Miguel Ojeda
maintainerPATCH 1/1 rust: maple_tree: fix intra-doc link
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.
---
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(-)
rust/kernel/maple_tree.rs +3 -4
@@ -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
Quoted 20 lines · Miguel Ojeda
A couple
Occupiedintra-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 namedOccupiedin scope
|
= help: to escape[and]characters, add '\' before them like\[or\]= note:-D rustdoc::broken-intra-doc-linksimplied by-D warnings= help: to override-D warningsadd#[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 namedOccupiedin scope
|
= help: to escape[and]characters, add '\' before them like\[or\]
Quoted 4 lines
Thus fix them.
Fixes 7f51d867d2ed ("rust: maple_tree: add MapleTree")Signed-off-by Miguel Ojeda <[email protected]>
Quoted 3 lines · Miguel Ojeda
Andrew: as usual, please feel free to rebase if that is what you normally do, of course. This was in next-20250910. Thanks!
(Somehow I didn't Cc akpm -- doing it now.)
Could this be picked up? It blocks generation of docs for linux-next. Thanks!
By the way, there was a rebase -- the tag should now be:
Cheers,
Miguel