docs: nouveau: remove invalid kernel-doc reference to r535.c

[PATCH] docs: nouveau: remove invalid kernel-doc reference to r535.c

Posted by HyeonSu Jeon 3 months, 3 weeks ago

The file drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c does not exist
in the tree, but is referenced in gsp.rst via a kernel-doc directive.
This causes an error during the documentation build

Removing this refernce resolves the error

Signed-off-by: HyeonSu Jeon <dev.hyeonsu.jeon@gmail.com>
---
 Documentation/gpu/nouveau.rst | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/Documentation/gpu/nouveau.rst b/Documentation/gpu/nouveau.rst
index b8c801e0068c..cab4a8eda850 100644
--- a/Documentation/gpu/nouveau.rst
+++ b/Documentation/gpu/nouveau.rst
@@ -25,8 +25,5 @@ providing a consistent API to upper layers of the driver stack.
 GSP Support
 ------------------------
 
-.. kernel-doc:: drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
-   :doc: GSP message queue element
-
 .. kernel-doc:: drivers/gpu/drm/nouveau/include/nvkm/subdev/gsp.h
    :doc: GSP message handling policy
-- 
2.34.1

Re: [PATCH] docs: nouveau: remove invalid kernel-doc reference to r535.c

Posted by Randy Dunlap 3 months, 3 weeks ago

Hi,

On 6/15/25 7:17 PM, HyeonSu Jeon wrote:
> The file drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c does not exist
> in the tree, but is referenced in gsp.rst via a kernel-doc directive.
> This causes an error during the documentation build
> 
> Removing this refernce resolves the error
> 
> Signed-off-by: HyeonSu Jeon <dev.hyeonsu.jeon@gmail.com>

Thanks for your patch.
A previous patch has already been applied to drm-misc-fixes:

https://lore.kernel.org/linux-doc/20250611020805.22418-2-bagasdotme@gmail.com/

> ---
>  Documentation/gpu/nouveau.rst | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/gpu/nouveau.rst b/Documentation/gpu/nouveau.rst
> index b8c801e0068c..cab4a8eda850 100644
> --- a/Documentation/gpu/nouveau.rst
> +++ b/Documentation/gpu/nouveau.rst
> @@ -25,8 +25,5 @@ providing a consistent API to upper layers of the driver stack.
>  GSP Support
>  ------------------------
>  
> -.. kernel-doc:: drivers/gpu/drm/nouveau/nvkm/subdev/gsp/r535.c
> -   :doc: GSP message queue element
> -
>  .. kernel-doc:: drivers/gpu/drm/nouveau/include/nvkm/subdev/gsp.h
>     :doc: GSP message handling policy

-- 
~Randy