Skip to contentSkip to conversation

Documentation: nouveau: Update GSP message queue kernel-doc reference

PATCH Applied Bagas Sanjaya 3 participants 3 messages Jun 11, 2025 – Jun 13, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Documentation: nouveau: Update GSP message queue kernel-doc reference

GSP message queue docs has been moved following RPC handling split in 8a8b1ec5261f20 ("drm/nouveau/gsp: split rpc handling out on its own"), before GSP-RM implementation is versioned in c472d828348caf ("drm/nouveau/gsp: move subdev/engine impls to subdev/gsp/rm/r535/"). However, the kernel-doc reference in nouveau docs is left behind, which triggers htmldocs warnings:

ERROR: Cannot find file ./drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
WARNING: No kernel-doc for file ./drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c

Update the reference.

Fixes c472d828348c ("drm/nouveau/gsp: move subdev/engine impls to subdev/gsp/rm/r535/")
Fixes 8a8b1ec5261f ("drm/nouveau/gsp: split rpc handling out on its own")

---
Changes since v1 [1]:

- Correct GSP kernel-doc reference file (Randy)

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 Documentation/gpu/nouveau.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gpu/nouveau.rst +1 -1
index b8c801e0068cb0..cab2e81013bc5f 100644
@@ -25,7 +25,7 @@ providing a consistent API to upper layers of the driver stack.
 GSP Support
 ------------------------
 
-.. kernel-doc:: drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
+.. kernel-doc:: drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/rpc.c
    :doc: GSP message queue element
 
 .. kernel-doc:: drivers/gpu/drm/nouveau/include/nvkm/subdev/gsp.h

base-commit: 19272b37aa4f83ca52bdf9c16d5d81bdd1354494

Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Acked-by Tested-by on v2 1/1
#1 lore raw
Quoted 7 lines · Bagas Sanjaya

GSP message queue docs has been moved following RPC handling split in 8a8b1ec5261f20 ("drm/nouveau/gsp: split rpc handling out on its own"), before GSP-RM implementation is versioned in c472d828348caf ("drm/nouveau/gsp: move subdev/engine impls to subdev/gsp/rm/r535/"). However, the kernel-doc reference in nouveau docs is left behind, which triggers htmldocs warnings:

Quoted 8 lines

ERROR: Cannot find file ./drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
WARNING: No kernel-doc for file ./drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c

Update the reference.

Fixes c472d828348c ("drm/nouveau/gsp: move subdev/engine impls to subdev/gsp/rm/r535/")
Fixes 8a8b1ec5261f ("drm/nouveau/gsp: split rpc handling out on its own")

Thanks.

Quoted 25 lines

---
Changes since v1 [1]:

- Correct GSP kernel-doc reference file (Randy)

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 Documentation/gpu/nouveau.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gpu/nouveau.rst +1 -1
index b8c801e0068cb0..cab2e81013bc5f 100644
@@ -25,7 +25,7 @@ providing a consistent API to upper layers of the driver stack.
 GSP Support
 ------------------------
 
-.. kernel-doc:: drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
+.. kernel-doc:: drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/rpc.c
    :doc: GSP message queue element
 
 .. kernel-doc:: drivers/gpu/drm/nouveau/include/nvkm/subdev/gsp.h

base-commit: 19272b37aa4f83ca52bdf9c16d5d81bdd1354494

Signature · 1 line
~Randy
#2 lore raw
In reply to Bagas Sanjaya
Quoted 7 lines · Bagas Sanjaya

GSP message queue docs has been moved following RPC handling split in 8a8b1ec5261f20 ("drm/nouveau/gsp: split rpc handling out on its own"), before GSP-RM implementation is versioned in c472d828348caf ("drm/nouveau/gsp: move subdev/engine impls to subdev/gsp/rm/r535/"). However, the kernel-doc reference in nouveau docs is left behind, which triggers htmldocs warnings:

Quoted 8 lines

ERROR: Cannot find file ./drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
WARNING: No kernel-doc for file ./drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c

Update the reference.

Fixes c472d828348c ("drm/nouveau/gsp: move subdev/engine impls to subdev/gsp/rm/r535/")
Fixes 8a8b1ec5261f ("drm/nouveau/gsp: split rpc handling out on its own")

Applied to drm-misc-fixes, thanks!