rust: id_pool: fix broken intra-doc link

[PATCH] rust: id_pool: fix broken intra-doc link

Posted by Miguel Ojeda 3 days, 23 hours ago

`rustdoc` detects a broken intra-doc link:

    error: unresolved link to `BitmapVec::NO_ALLOC_MAX_LEN`
       --> rust/kernel/id_pool.rs:100:31
        |
    100 |     /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
        |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `NO_ALLOC_MAX_LEN`
        |
        = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
        = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`

Thus fix it.

It was a missed rename in v5 of the patch series adding this [1].

Fixes: feb3fdf1239a ("rust: id_pool: do not supply starting capacity")
Link: https://lore.kernel.org/all/20251112-binder-bitmap-v5-0-8b9d7c7eca82@google.com/ [1]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
I saw this in next-20251127.

I think using [`BitmapVec::MAX_INLINE_LEN`] is clearer in general,
especially for things in other modules, but I kept the same style as
other links in the file.

 rust/kernel/id_pool.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/rust/kernel/id_pool.rs b/rust/kernel/id_pool.rs
index a4c37d6a0971..73a952d7dd83 100644
--- a/rust/kernel/id_pool.rs
+++ b/rust/kernel/id_pool.rs
@@ -95,9 +95,9 @@ pub fn realloc(&self, flags: Flags) -> Result<PoolResizer, AllocError> {
 impl IdPool {
     /// Constructs a new [`IdPool`].
     ///
-    /// The pool will have a capacity of [`NO_ALLOC_MAX_LEN`].
+    /// The pool will have a capacity of [`MAX_INLINE_LEN`].
     ///
-    /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
+    /// [`MAX_INLINE_LEN`]: BitmapVec::MAX_INLINE_LEN
     #[inline]
     pub fn new() -> Self {
         Self {

base-commit: a322638c15a678168aeb8dc11c8760f8a053124d
--
2.52.0

Re: [PATCH] rust: id_pool: fix broken intra-doc link

Posted by Alice Ryhl 3 days, 11 hours ago

On Thu, Nov 27, 2025 at 10:33:40PM +0100, Miguel Ojeda wrote:
> `rustdoc` detects a broken intra-doc link:
> 
>     error: unresolved link to `BitmapVec::NO_ALLOC_MAX_LEN`
>        --> rust/kernel/id_pool.rs:100:31
>         |
>     100 |     /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
>         |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `NO_ALLOC_MAX_LEN`
>         |
>         = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
>         = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
> 
> Thus fix it.
> 
> It was a missed rename in v5 of the patch series adding this [1].
> 
> Fixes: feb3fdf1239a ("rust: id_pool: do not supply starting capacity")
> Link: https://lore.kernel.org/all/20251112-binder-bitmap-v5-0-8b9d7c7eca82@google.com/ [1]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

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

Re: [PATCH] rust: id_pool: fix broken intra-doc link

Posted by Yury Norov 3 days, 18 hours ago

On Thu, Nov 27, 2025 at 10:33:40PM +0100, Miguel Ojeda wrote:
> `rustdoc` detects a broken intra-doc link:
> 
>     error: unresolved link to `BitmapVec::NO_ALLOC_MAX_LEN`
>        --> rust/kernel/id_pool.rs:100:31
>         |
>     100 |     /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
>         |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `NO_ALLOC_MAX_LEN`
>         |
>         = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
>         = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
> 
> Thus fix it.
> 
> It was a missed rename in v5 of the patch series adding this [1].
> 
> Fixes: feb3fdf1239a ("rust: id_pool: do not supply starting capacity")
> Link: https://lore.kernel.org/all/20251112-binder-bitmap-v5-0-8b9d7c7eca82@google.com/ [1]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
> I saw this in next-20251127.
> 
> I think using [`BitmapVec::MAX_INLINE_LEN`] is clearer in general,
> especially for things in other modules, but I kept the same style as
> other links in the file.
 
Thanks, added it on top of Alice's series. 

>  rust/kernel/id_pool.rs | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/rust/kernel/id_pool.rs b/rust/kernel/id_pool.rs
> index a4c37d6a0971..73a952d7dd83 100644
> --- a/rust/kernel/id_pool.rs
> +++ b/rust/kernel/id_pool.rs
> @@ -95,9 +95,9 @@ pub fn realloc(&self, flags: Flags) -> Result<PoolResizer, AllocError> {
>  impl IdPool {
>      /// Constructs a new [`IdPool`].
>      ///
> -    /// The pool will have a capacity of [`NO_ALLOC_MAX_LEN`].
> +    /// The pool will have a capacity of [`MAX_INLINE_LEN`].
>      ///
> -    /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
> +    /// [`MAX_INLINE_LEN`]: BitmapVec::MAX_INLINE_LEN
>      #[inline]
>      pub fn new() -> Self {
>          Self {
> 
> base-commit: a322638c15a678168aeb8dc11c8760f8a053124d
> --
> 2.52.0

Re: [PATCH] rust: id_pool: fix broken intra-doc link

Posted by Yury Norov 3 days, 18 hours ago

+ Philip Li <philip.li@intel.com>
+ Yujie Liu <yujie.liu@intel.com>
+ Stephen Rothwell <sfr@canb.auug.org.au>

It seems, the below error wasn't caught by lkp, neither by linux-next.

Can you guys please consider adding rustdoc target in your testing
grid?

Thanks,
Yury

On Thu, Nov 27, 2025 at 09:15:31PM -0500, Yury Norov wrote:
> On Thu, Nov 27, 2025 at 10:33:40PM +0100, Miguel Ojeda wrote:
> > `rustdoc` detects a broken intra-doc link:
> > 
> >     error: unresolved link to `BitmapVec::NO_ALLOC_MAX_LEN`
> >        --> rust/kernel/id_pool.rs:100:31
> >         |
> >     100 |     /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
> >         |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `NO_ALLOC_MAX_LEN`
> >         |
> >         = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
> >         = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
> > 
> > Thus fix it.
> > 
> > It was a missed rename in v5 of the patch series adding this [1].
> > 
> > Fixes: feb3fdf1239a ("rust: id_pool: do not supply starting capacity")
> > Link: https://lore.kernel.org/all/20251112-binder-bitmap-v5-0-8b9d7c7eca82@google.com/ [1]
> > Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> > ---
> > I saw this in next-20251127.
> > 
> > I think using [`BitmapVec::MAX_INLINE_LEN`] is clearer in general,
> > especially for things in other modules, but I kept the same style as
> > other links in the file.
>  
> Thanks, added it on top of Alice's series. 
> 
> >  rust/kernel/id_pool.rs | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/rust/kernel/id_pool.rs b/rust/kernel/id_pool.rs
> > index a4c37d6a0971..73a952d7dd83 100644
> > --- a/rust/kernel/id_pool.rs
> > +++ b/rust/kernel/id_pool.rs
> > @@ -95,9 +95,9 @@ pub fn realloc(&self, flags: Flags) -> Result<PoolResizer, AllocError> {
> >  impl IdPool {
> >      /// Constructs a new [`IdPool`].
> >      ///
> > -    /// The pool will have a capacity of [`NO_ALLOC_MAX_LEN`].
> > +    /// The pool will have a capacity of [`MAX_INLINE_LEN`].
> >      ///
> > -    /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
> > +    /// [`MAX_INLINE_LEN`]: BitmapVec::MAX_INLINE_LEN
> >      #[inline]
> >      pub fn new() -> Self {
> >          Self {
> > 
> > base-commit: a322638c15a678168aeb8dc11c8760f8a053124d
> > --
> > 2.52.0

Re: [PATCH] rust: id_pool: fix broken intra-doc link

Posted by Philip Li 1 day, 15 hours ago

On Thu, Nov 27, 2025 at 09:31:54PM -0500, Yury Norov wrote:
> + Philip Li <philip.li@intel.com>
> + Yujie Liu <yujie.liu@intel.com>
> + Stephen Rothwell <sfr@canb.auug.org.au>
> 
> It seems, the below error wasn't caught by lkp, neither by linux-next.

Sorry, the bot does have rustdoc running, but missed this one.

> 
> Can you guys please consider adding rustdoc target in your testing
> grid?

Got it Yury, I will follow up this to make rustdoc check work effectively
in the bot.

> 
> Thanks,
> Yury
> 
> On Thu, Nov 27, 2025 at 09:15:31PM -0500, Yury Norov wrote:
> > On Thu, Nov 27, 2025 at 10:33:40PM +0100, Miguel Ojeda wrote:
> > > `rustdoc` detects a broken intra-doc link:
> > > 
> > >     error: unresolved link to `BitmapVec::NO_ALLOC_MAX_LEN`
> > >        --> rust/kernel/id_pool.rs:100:31
> > >         |
> > >     100 |     /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
> > >         |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `BitmapVec` has no field or associated item named `NO_ALLOC_MAX_LEN`
> > >         |
> > >         = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
> > >         = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
> > > 
> > > Thus fix it.
> > > 
> > > It was a missed rename in v5 of the patch series adding this [1].
> > > 
> > > Fixes: feb3fdf1239a ("rust: id_pool: do not supply starting capacity")
> > > Link: https://lore.kernel.org/all/20251112-binder-bitmap-v5-0-8b9d7c7eca82@google.com/ [1]
> > > Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> > > ---
> > > I saw this in next-20251127.
> > > 
> > > I think using [`BitmapVec::MAX_INLINE_LEN`] is clearer in general,
> > > especially for things in other modules, but I kept the same style as
> > > other links in the file.
> >  
> > Thanks, added it on top of Alice's series. 
> > 
> > >  rust/kernel/id_pool.rs | 4 ++--
> > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > 
> > > diff --git a/rust/kernel/id_pool.rs b/rust/kernel/id_pool.rs
> > > index a4c37d6a0971..73a952d7dd83 100644
> > > --- a/rust/kernel/id_pool.rs
> > > +++ b/rust/kernel/id_pool.rs
> > > @@ -95,9 +95,9 @@ pub fn realloc(&self, flags: Flags) -> Result<PoolResizer, AllocError> {
> > >  impl IdPool {
> > >      /// Constructs a new [`IdPool`].
> > >      ///
> > > -    /// The pool will have a capacity of [`NO_ALLOC_MAX_LEN`].
> > > +    /// The pool will have a capacity of [`MAX_INLINE_LEN`].
> > >      ///
> > > -    /// [`NO_ALLOC_MAX_LEN`]: BitmapVec::NO_ALLOC_MAX_LEN
> > > +    /// [`MAX_INLINE_LEN`]: BitmapVec::MAX_INLINE_LEN
> > >      #[inline]
> > >      pub fn new() -> Self {
> > >          Self {
> > > 
> > > base-commit: a322638c15a678168aeb8dc11c8760f8a053124d
> > > --
> > > 2.52.0