[PATCH 6.18.y] rust: bitmap: fix intra-doc link

[PATCH 6.18.y] rust: bitmap: fix intra-doc link

[Miguel Ojeda]

`BitmapVec::MAX_LEN` does not exist in 6.18.y, so `rustdoc` warns:

    warning: unresolved link to `BitmapVec::MAX_LEN`
      --> rust/kernel/bitmap.rs:24:25
       |
    24 | /// This also matches [`BitmapVec::MAX_LEN`].
       |                         ^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `MAX_LEN`
       |
       = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

Thus link to `BitmapVec::new()` instead.

Fixes: 37f45fe068e0 ("rust: bitmap: restrict bitmap length to at most i32::MAX")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
Another option (cleaner but a bigger change) is to cherry-pick:

  f5535d78e126 ("rust: bitmap: add MAX_LEN and MAX_INLINE_LEN constants")

 rust/kernel/bitmap.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/bitmap.rs b/rust/kernel/bitmap.rs
index c2634561b023..badc3eb5282b 100644
--- a/rust/kernel/bitmap.rs
+++ b/rust/kernel/bitmap.rs
@@ -21,7 +21,7 @@
 /// Must reference a `[c_ulong]` long enough to fit `data.len()` bits.
 /// Must not be longer than [`i32::MAX`] bits, so offsets and lengths used with
 /// [`Bitmap`] functions fit in the `int` and `unsigned int` arguments of the C bitmap API.
-/// This also matches [`BitmapVec::MAX_LEN`].
+/// This also matches the maximum length accepted by [`BitmapVec::new`].
 #[cfg_attr(CONFIG_64BIT, repr(align(8)))]
 #[cfg_attr(not(CONFIG_64BIT), repr(align(4)))]
 pub struct Bitmap {

base-commit: a7c80de5ffd00886e3e6b7469611536b0d481cda
--
2.56.0

Re: [PATCH 6.18.y] rust: bitmap: fix intra-doc link

[Alice Ryhl]

On Fri, Nov 06, 2026 at 07:37:45AM +0100, Miguel Ojeda wrote:
> `BitmapVec::MAX_LEN` does not exist in 6.18.y, so `rustdoc` warns:
> 
>     warning: unresolved link to `BitmapVec::MAX_LEN`
>       --> rust/kernel/bitmap.rs:24:25
>        |
>     24 | /// This also matches [`BitmapVec::MAX_LEN`].
>        |                         ^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `MAX_LEN`
>        |
>        = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
> 
> Thus link to `BitmapVec::new()` instead.
> 
> Fixes: 37f45fe068e0 ("rust: bitmap: restrict bitmap length to at most i32::MAX")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
> Another option (cleaner but a bigger change) is to cherry-pick:
> 
>   f5535d78e126 ("rust: bitmap: add MAX_LEN and MAX_INLINE_LEN constants")

Both options (this one-liner fix or cherry-picking f5535d78e126) look good to
me.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

Alice

Re: [PATCH 6.18.y] rust: bitmap: fix intra-doc link

[Sasha Levin]

> `BitmapVec::MAX_LEN` does not exist in 6.18.y, so `rustdoc` warns:

Queued for 6.18, thanks.

-- 
Thanks,
Sasha