From: Joel Fernandes <joelagnelf@nvidia.com>
To: Alexandre Courbot <acourbot@nvidia.com>
Cc: linux-kernel@vger.kernel.org, Danilo Krummrich <dakr@kernel.org>,
Miguel Ojeda <ojeda@kernel.org>, Boqun Feng <boqun@kernel.org>,
Gary Guo <gary@garyguo.net>, Benno Lossin <lossin@kernel.org>,
Andreas Hindborg <a.hindborg@kernel.org>,
Alice Ryhl <aliceryhl@google.com>,
Trevor Gross <tmgross@umich.edu>,
Dave Airlie <airlied@redhat.com>,
Daniel Almeida <daniel.almeida@collabora.com>,
dri-devel@lists.freedesktop.org, nouveau@lists.freedesktop.org,
rust-for-linux@vger.kernel.org,
Nikola Djukic <ndjukic@nvidia.com>
Subject: Re: [PATCH v10 6/8] rust: gpu: Add GPU buddy allocator bindings
Date: Sun, 22 Feb 2026 20:02:16 -0500 [thread overview]
Message-ID: <6fbd540a-d329-44b1-9986-67c64acb0605@nvidia.com> (raw)
In-Reply-To: <DGJEZQ9WB8GM.15TPJZKG3G5P4@nvidia.com>
On 2/19/2026 8:56 PM, Alexandre Courbot wrote:
> On Fri Feb 20, 2026 at 12:31 AM JST, Joel Fernandes wrote:
>> On Thu, Feb 19, 2026 at 02:13:37PM +0900, Alexandre Courbot wrote:
>>>> + types::Opaque,
>>>
>>> Need a `//` or `rustfmt` will reformat.
>>
>> Fixed, thanks.
>>
>>>> +// SAFETY: [`GpuBuddyInner`] can be sent between threads.
>>>
>>> No need to link on non-doccomments.
>>
>> Fixed. Removed the brackets from SAFETY comments for GpuBuddyInner
>> and GpuBuddyGuard.
>>
>>>> +/// - `buddy` references a valid [`GpuBuddyInner`].
>>>
>>> rustdoc complains that this links to a private item in a public doc - we
>>> should not mention `GpuBuddyInner` here.
>>
>> Per Miguel's reply, I've kept the mention but removed the square
>> brackets so it doesn't try to create a link. This way it's still
>> mentioned for practical reference without triggering the rustdoc
>> warning.
>
> Won't it be confusing for readers of the public documentation? If a type
> is private, it shouldn't be needed to folks who read the HTML.
>
> This sounds like we instead want a regular `//` comment somewhere to
> guide those who brave the code.
You are right about the audience of the docs perhaps not requiring this
information. I will remove it then.
thanks,
--
Joel Fernandes
next prev parent reply other threads:[~2026-02-23 1:02 UTC|newest]
Thread overview: 74+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-18 20:54 [PATCH v10 0/8] Preparatory patches for nova-core memory management Joel Fernandes
2026-02-18 20:54 ` [PATCH v10 1/8] gpu: Move DRM buddy allocator one level up (part one) Joel Fernandes
2026-02-18 20:55 ` [PATCH v10 2/8] gpu: Move DRM buddy allocator one level up (part two) Joel Fernandes
2026-02-19 3:18 ` Alexandre Courbot
2026-02-19 15:31 ` Joel Fernandes
2026-02-18 20:55 ` [PATCH v10 3/8] gpu: Fix uninitialized buddy for built-in drivers Joel Fernandes
2026-02-19 10:09 ` Danilo Krummrich
2026-02-19 15:31 ` Joel Fernandes
2026-02-19 16:24 ` Joel Fernandes
2026-02-18 20:55 ` [PATCH v10 4/8] rust: ffi: Convert pub use to pub mod and create ffi module Joel Fernandes
2026-02-19 3:18 ` Alexandre Courbot
2026-02-18 20:55 ` [PATCH v10 5/8] rust: clist: Add support to interface with C linked lists Joel Fernandes
2026-02-19 4:26 ` Alexandre Courbot
2026-02-19 15:27 ` Joel Fernandes
2026-02-19 9:58 ` Danilo Krummrich
2026-02-19 15:28 ` Joel Fernandes
2026-02-19 11:21 ` Danilo Krummrich
2026-02-19 14:37 ` Gary Guo
2026-02-19 15:27 ` Joel Fernandes
2026-02-19 15:44 ` Joel Fernandes
2026-02-19 16:24 ` Danilo Krummrich
2026-02-19 18:07 ` Joel Fernandes
2026-02-19 18:38 ` Miguel Ojeda
2026-02-19 19:28 ` Joel Fernandes
2026-02-19 22:55 ` Miguel Ojeda
2026-02-20 4:00 ` Joel Fernandes
2026-02-20 1:56 ` Alexandre Courbot
2026-02-20 1:09 ` Gary Guo
2026-02-20 1:19 ` Miguel Ojeda
2026-02-20 16:48 ` Danilo Krummrich
2026-02-23 0:54 ` Joel Fernandes
2026-02-24 16:15 ` Miguel Ojeda
2026-02-25 19:48 ` Boqun Feng
2026-02-25 20:20 ` Joel Fernandes
2026-02-26 0:32 ` Joel Fernandes
2026-02-20 8:16 ` Eliot Courtney
2026-02-23 1:13 ` Joel Fernandes
2026-02-24 2:08 ` Eliot Courtney
2026-02-24 7:28 ` Alice Ryhl
2026-02-24 16:00 ` Joel Fernandes
2026-02-24 16:11 ` Miguel Ojeda
2026-02-21 8:59 ` Alice Ryhl
2026-02-23 0:41 ` Joel Fernandes
2026-02-23 9:38 ` Alice Ryhl
2026-02-24 0:32 ` Joel Fernandes
2026-02-18 20:55 ` [PATCH v10 6/8] rust: gpu: Add GPU buddy allocator bindings Joel Fernandes
2026-02-19 5:13 ` Alexandre Courbot
2026-02-19 8:54 ` Miguel Ojeda
2026-02-19 15:31 ` Joel Fernandes
2026-03-01 13:23 ` Gary Guo
2026-03-01 17:53 ` Miguel Ojeda
2026-02-19 15:31 ` Joel Fernandes
2026-02-20 1:56 ` Alexandre Courbot
2026-02-23 1:02 ` Joel Fernandes [this message]
2026-02-19 13:18 ` Danilo Krummrich
2026-02-19 15:31 ` Joel Fernandes
2026-02-20 8:22 ` Eliot Courtney
2026-02-20 14:54 ` Joel Fernandes
2026-02-20 15:50 ` Joel Fernandes
2026-02-20 15:53 ` Danilo Krummrich
2026-02-20 21:20 ` Joel Fernandes
2026-02-20 23:43 ` Danilo Krummrich
2026-02-23 0:34 ` Joel Fernandes
2026-02-18 20:55 ` [PATCH v10 7/8] nova-core: mm: Select GPU_BUDDY for VRAM allocation Joel Fernandes
2026-02-19 0:44 ` Alexandre Courbot
2026-02-19 1:14 ` John Hubbard
2026-02-19 15:31 ` Joel Fernandes
2026-02-19 2:06 ` Joel Fernandes
2026-02-19 15:31 ` Joel Fernandes
2026-02-18 20:55 ` [PATCH v10 8/8] nova-core: Kconfig: Sort select statements alphabetically Joel Fernandes
2026-02-18 20:59 ` [PATCH v10 0/8] Preparatory patches for nova-core memory management Joel Fernandes
2026-02-18 22:24 ` Danilo Krummrich
2026-02-18 23:46 ` Joel Fernandes
2026-02-18 23:59 ` Joel Fernandes
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=6fbd540a-d329-44b1-9986-67c64acb0605@nvidia.com \
--to=joelagnelf@nvidia.com \
--cc=a.hindborg@kernel.org \
--cc=acourbot@nvidia.com \
--cc=airlied@redhat.com \
--cc=aliceryhl@google.com \
--cc=boqun@kernel.org \
--cc=dakr@kernel.org \
--cc=daniel.almeida@collabora.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=ndjukic@nvidia.com \
--cc=nouveau@lists.freedesktop.org \
--cc=ojeda@kernel.org \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Powered by JetHome