gpu: nova-core: gsp: fix a broken doc link on GspMessage
Subsystems (4)
PATCH 1/1 gpu: nova-core: gsp: fix a broken doc link on GspMessage
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.
--- drivers/gpu/nova-core/gsp/cmdq.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/nova-core/gsp/cmdq.rs +1 -1
@@ -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: &'aGspMsgElement ,
base-commit: 6cb331644c441ff4101a4f8726283a6ed0d5947e
Signature · 1 line
2.55.0
Quoted 9 lines · 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
nit: kernel policy has changed and this should just say "Assisted-by: LLM" now.
Quoted 1 line
Signed-off-by John Hubbard <[email protected]>
Quoted 3 lines
--- drivers/gpu/nova-core/gsp/cmdq.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 7 lines · Gary Guo
Quoted 6 lines · 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.
Quoted 5 lines
Quoted 3 lines
Point the link at CmdqInner.
Assisted-by Cursor:claude-opus-5nit: 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.
Quoted 5 lines
Quoted 2 lines
Signed-off-by John Hubbard <[email protected]>Reviewed-by Gary Guo <[email protected]>
thanks,
Signature · 1 line
John Hubbard
Quoted 1 line · John Hubbard
[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.