* [PATCH] Documentation: nouveau: Update GSP message queue kernel-doc reference
@ 2025-06-10 6:52 Bagas Sanjaya
2025-06-10 7:34 ` Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Bagas Sanjaya @ 2025-06-10 6:52 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation,
Linux DRI Development, Linux Nouveau
Cc: David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, Jonathan Corbet, Dave Airlie, Timur Tabi,
Ben Skeggs, Bagas Sanjaya
Commit c472d828348caf ("drm/nouveau/gsp: move subdev/engine impls to
subdev/gsp/rm/r535/") moves GSP-RM message queue implementation in
drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c to versioned path in
drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/gsp.c, but forgets to
update kernel-doc reference in nouveau docs, hence 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/")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/gpu/nouveau.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/gpu/nouveau.rst b/Documentation/gpu/nouveau.rst
index b8c801e0068cb0..878fb1ade31e4c 100644
--- a/Documentation/gpu/nouveau.rst
+++ b/Documentation/gpu/nouveau.rst
@@ -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/gsp.c
:doc: GSP message queue element
.. kernel-doc:: drivers/gpu/drm/nouveau/include/nvkm/subdev/gsp.h
base-commit: 19272b37aa4f83ca52bdf9c16d5d81bdd1354494
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] Documentation: nouveau: Update GSP message queue kernel-doc reference
2025-06-10 6:52 [PATCH] Documentation: nouveau: Update GSP message queue kernel-doc reference Bagas Sanjaya
@ 2025-06-10 7:34 ` Randy Dunlap
2025-06-10 8:48 ` Bagas Sanjaya
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2025-06-10 7:34 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux DRI Development, Linux Nouveau
Cc: David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, Jonathan Corbet, Dave Airlie, Timur Tabi,
Ben Skeggs
On 6/9/25 11:52 PM, Bagas Sanjaya wrote:
> Commit c472d828348caf ("drm/nouveau/gsp: move subdev/engine impls to
> subdev/gsp/rm/r535/") moves GSP-RM message queue implementation in
> drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c to versioned path in
> drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/gsp.c, but forgets to
> update kernel-doc reference in nouveau docs, hence 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/")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Documentation/gpu/nouveau.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/gpu/nouveau.rst b/Documentation/gpu/nouveau.rst
> index b8c801e0068cb0..878fb1ade31e4c 100644
> --- a/Documentation/gpu/nouveau.rst
> +++ b/Documentation/gpu/nouveau.rst
> @@ -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/gsp.c
Are you sure? Did that work for you?
I see
/**
* DOC: GSP message queue element
in drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/rpc.c but not in the
file that you referenced. Maybe it just keeps moving around...
This works for me. Please send a v2 if you see the need to.
> :doc: GSP message queue element
>
> .. kernel-doc:: drivers/gpu/drm/nouveau/include/nvkm/subdev/gsp.h
>
> base-commit: 19272b37aa4f83ca52bdf9c16d5d81bdd1354494
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Documentation: nouveau: Update GSP message queue kernel-doc reference
2025-06-10 7:34 ` Randy Dunlap
@ 2025-06-10 8:48 ` Bagas Sanjaya
0 siblings, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2025-06-10 8:48 UTC (permalink / raw)
To: Randy Dunlap, Linux Kernel Mailing List, Linux Documentation,
Linux DRI Development, Linux Nouveau
Cc: David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, Jonathan Corbet, Dave Airlie, Timur Tabi,
Ben Skeggs
[-- Attachment #1: Type: text/plain, Size: 1935 bytes --]
On Tue, Jun 10, 2025 at 12:34:06AM -0700, Randy Dunlap wrote:
>
>
> On 6/9/25 11:52 PM, Bagas Sanjaya wrote:
> > Commit c472d828348caf ("drm/nouveau/gsp: move subdev/engine impls to
> > subdev/gsp/rm/r535/") moves GSP-RM message queue implementation in
> > drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c to versioned path in
> > drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/gsp.c, but forgets to
> > update kernel-doc reference in nouveau docs, hence 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/")
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> > ---
> > Documentation/gpu/nouveau.rst | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/gpu/nouveau.rst b/Documentation/gpu/nouveau.rst
> > index b8c801e0068cb0..878fb1ade31e4c 100644
> > --- a/Documentation/gpu/nouveau.rst
> > +++ b/Documentation/gpu/nouveau.rst
> > @@ -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/gsp.c
>
> Are you sure? Did that work for you?
>
> I see
> /**
> * DOC: GSP message queue element
>
> in drivers/gpu/drm/nouveau/nvkm/subdev/gsp/rm/r535/rpc.c but not in the
> file that you referenced. Maybe it just keeps moving around...
Indeed, the same GSP docs as in v6.15.
>
>
> This works for me. Please send a v2 if you see the need to.
OK. I will send v2 tomorrow.
Thanks.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-06-10 8:48 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-06-10 6:52 [PATCH] Documentation: nouveau: Update GSP message queue kernel-doc reference Bagas Sanjaya
2025-06-10 7:34 ` Randy Dunlap
2025-06-10 8:48 ` Bagas Sanjaya
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).