mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
@ 2026-09-05  2:38 John Hubbard
  2026-09-05 14:25 ` Gary Guo
  0 siblings, 1 reply; 3+ messages in thread
From: John Hubbard @ 2026-09-05  2:38 UTC (permalink / raw)
  To: Danilo Krummrich, Alexandre Courbot
  Cc: Timur Tabi, Alistair Popple, Eliot Courtney, Zhi Wang,
	David Airlie, Simona Vetter, Bjorn Helgaas, Miguel Ojeda,
	Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron,
	Benno Lossin, Andreas Hindborg, Alice Ryhl, Trevor Gross,
	nova-gpu, LKML, John Hubbard

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
  2026-09-05  2:38 [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage John Hubbard
@ 2026-09-05 14:25 ` Gary Guo
  2026-09-05 17:23   ` John Hubbard
  0 siblings, 1 reply; 3+ messages in thread
From: Gary Guo @ 2026-09-05 14:25 UTC (permalink / raw)
  To: John Hubbard, Danilo Krummrich, Alexandre Courbot
  Cc: Timur Tabi, Alistair Popple, Eliot Courtney, Zhi Wang,
	David Airlie, Simona Vetter, Bjorn Helgaas, Miguel Ojeda,
	Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron,
	Benno Lossin, Andreas Hindborg, Alice Ryhl, Trevor Gross,
	nova-gpu, LKML

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(-)


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage
  2026-09-05 14:25 ` Gary Guo
@ 2026-09-05 17:23   ` John Hubbard
  0 siblings, 0 replies; 3+ messages in thread
From: John Hubbard @ 2026-09-05 17:23 UTC (permalink / raw)
  To: Gary Guo, Danilo Krummrich, Alexandre Courbot
  Cc: Timur Tabi, Alistair Popple, Eliot Courtney, Zhi Wang,
	David Airlie, Simona Vetter, Bjorn Helgaas, Miguel Ojeda,
	Alex Gaynor, Boqun Feng, Björn Roy Baron, Benno Lossin,
	Andreas Hindborg, Alice Ryhl, Trevor Gross, nova-gpu, LKML

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-09-05 17:23 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-09-05  2:38 [PATCH] gpu: nova-core: gsp: fix a broken doc link on GspMessage John Hubbard
2026-09-05 14:25 ` Gary Guo
2026-09-05 17:23   ` John Hubbard

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®