[PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage

John Hubbard posted 1 patch 2 weeks, 6 days ago
drivers/gpu/nova-core/gsp/cmdq.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
Posted by John Hubbard 2 weeks, 6 days ago
The doc comment on the GSP message type names Cmdq as the type that
defines wait_for_msg. That method belongs to CmdqInner, so the link has
no target. Nothing catches the break, because rustdoc resolves a link
only in an item it documents, and the kernel's rustdoc run skips private
items.

Point the link at CmdqInner.

Assisted-by: Cursor:claude-opus-5
Signed-off-by: John Hubbard <jhubbard@nvidia.com>
---
 drivers/gpu/nova-core/gsp/cmdq.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/nova-core/gsp/cmdq.rs b/drivers/gpu/nova-core/gsp/cmdq.rs
index 14a711307654..28876c4aa42c 100644
--- a/drivers/gpu/nova-core/gsp/cmdq.rs
+++ b/drivers/gpu/nova-core/gsp/cmdq.rs
@@ -478,7 +478,7 @@ struct GspCommand<'a> {
 
 /// A message ready to be processed from the message queue.
 ///
-/// This is the type returned by [`Cmdq::wait_for_msg`].
+/// This is the type returned by [`CmdqInner::wait_for_msg`].
 struct GspMessage<'a> {
     // Reference to the header of the message.
     header: &'a GspMsgElement,

base-commit: 6cb331644c441ff4101a4f8726283a6ed0d5947e
-- 
2.55.0
Re: [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
Posted by Danilo Krummrich 2 weeks, 6 days ago
On Fri,  4 Sep 2026 19:38:00 -0700, John Hubbard wrote:
> [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage

Applied, thanks!

  Branch: drm-rust-next
  Tree:   https://gitlab.freedesktop.org/drm/rust/kernel.git

[1/1] gpu: nova-core: gsp: fix a broken doc link on GspMessage
      commit: e1df8a1560a9

The patch will appear in the next linux-next integration (typically within 24
hours on weekdays).

The patch is queued up for the upcoming merge window for the next major kernel
release.
Re: [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
Posted by Gary Guo 2 weeks, 6 days ago
On Sat Sep 5, 2026 at 3:38 AM BST, John Hubbard wrote:
> The doc comment on the GSP message type names Cmdq as the type that
> defines wait_for_msg. That method belongs to CmdqInner, so the link has
> no target. Nothing catches the break, because rustdoc resolves a link
> only in an item it documents, and the kernel's rustdoc run skips private
> items.
> 
> Point the link at CmdqInner.
> 
> Assisted-by: Cursor:claude-opus-5

nit: kernel policy has changed and this should just say "Assisted-by: LLM" now.

> Signed-off-by: John Hubbard <jhubbard@nvidia.com>

Reviewed-by: Gary Guo <gary@garyguo.net>

> ---
>  drivers/gpu/nova-core/gsp/cmdq.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
Re: [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
Posted by John Hubbard 2 weeks, 6 days ago
On 9/5/26 7:25 AM, Gary Guo wrote:
> On Sat Sep 5, 2026 at 3:38 AM BST, John Hubbard wrote:
>> The doc comment on the GSP message type names Cmdq as the type that
>> defines wait_for_msg. That method belongs to CmdqInner, so the link has
>> no target. Nothing catches the break, because rustdoc resolves a link
>> only in an item it documents, and the kernel's rustdoc run skips private
>> items.
>>
>> Point the link at CmdqInner.
>>
>> Assisted-by: Cursor:claude-opus-5
> 
> nit: kernel policy has changed and this should just say "Assisted-by: LLM" now.

So it has! Perhaps Danilo or Alex can change that for me upon applying
this, to save a re-spin.

> 
>> Signed-off-by: John Hubbard <jhubbard@nvidia.com>
> 
> Reviewed-by: Gary Guo <gary@garyguo.net>
> 

thanks,
-- 
John Hubbard