From: Miguel Ojeda <ojeda@kernel.org>
To: "Liam R . Howlett" <Liam.Howlett@oracle.com>,
Miguel Ojeda <ojeda@kernel.org>,
Alex Gaynor <alex.gaynor@gmail.com>
Cc: "Alice Ryhl" <aliceryhl@google.com>,
"Andrew Ballance" <andrewjballance@gmail.com>,
maple-tree@lists.infradead.org, linux-mm@kvack.org,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
patches@lists.linux.dev
Subject: [PATCH] rust: maple_tree: fix intra-doc link
Date: Wed, 10 Sep 2025 16:02:12 +0200 [thread overview]
Message-ID: <20250910140212.997771-1-ojeda@kernel.org> (raw)
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@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
next reply other threads:[~2025-09-10 14:02 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-10 14:02 Miguel Ojeda [this message]
2025-09-12 8:07 ` [PATCH] rust: maple_tree: fix intra-doc link Alice Ryhl
2025-09-21 9:27 ` Miguel Ojeda
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250910140212.997771-1-ojeda@kernel.org \
--to=ojeda@kernel.org \
--cc=Liam.Howlett@oracle.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=andrewjballance@gmail.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=lossin@kernel.org \
--cc=maple-tree@lists.infradead.org \
--cc=patches@lists.linux.dev \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.