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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <aSkJml0FI9KGdhUz@yury>
Date: Thu, 27 Nov 2025 21:31:54 -0500
From: Yury Norov <yury.norov@...il.com>
To: Miguel Ojeda <ojeda@...nel.org>
Cc: Alice Ryhl <aliceryhl@...gle.com>, Burak Emir <bqe@...gle.com>,
	Alex Gaynor <alex.gaynor@...il.com>,
	Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <lossin@...nel.org>,
	Andreas Hindborg <a.hindborg@...nel.org>,
	Trevor Gross <tmgross@...ch.edu>, Philip Li <philip.li@...el.com>,
	Yujie Liu <yujie.liu@...el.com>,
	Stephen Rothwell <sfr@...b.auug.org.au>,
	Danilo Krummrich <dakr@...nel.org>, rust-for-linux@...r.kernel.org,
	linux-kernel@...r.kernel.org, patches@...ts.linux.dev
Subject: Re: [PATCH] rust: id_pool: fix broken intra-doc link

+ Philip Li <philip.li@...el.com>
+ Yujie Liu <yujie.liu@...el.com>
+ Stephen Rothwell <sfr@...b.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@...nel.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