rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philip Li <philip.li@intel.com>
To: Yury Norov <yury.norov@gmail.com>
Cc: "Miguel Ojeda" <ojeda@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Burak Emir" <bqe@google.com>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"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>,
	"Yujie Liu" <yujie.liu@intel.com>,
	"Stephen Rothwell" <sfr@canb.auug.org.au>,
	"Danilo Krummrich" <dakr@kernel.org>,
	rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	patches@lists.linux.dev
Subject: Re: [PATCH] rust: id_pool: fix broken intra-doc link
Date: Sun, 30 Nov 2025 13:53:27 +0800	[thread overview]
Message-ID: <aSvb17mOuXfrQdfl@rli9-mobl> (raw)
In-Reply-To: <aSkJml0FI9KGdhUz@yury>

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

  reply	other threads:[~2025-11-30  5:53 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-27 21:33 [PATCH] rust: id_pool: fix broken intra-doc link Miguel Ojeda
2025-11-28  2:15 ` Yury Norov
2025-11-28  2:31   ` Yury Norov
2025-11-30  5:53     ` Philip Li [this message]
2025-11-28  9:30 ` Alice Ryhl

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=aSvb17mOuXfrQdfl@rli9-mobl \
    --to=philip.li@intel.com \
    --cc=a.hindborg@kernel.org \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=bqe@google.com \
    --cc=dakr@kernel.org \
    --cc=gary@garyguo.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=ojeda@kernel.org \
    --cc=patches@lists.linux.dev \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    --cc=tmgross@umich.edu \
    --cc=yujie.liu@intel.com \
    --cc=yury.norov@gmail.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).