2023-09-26 16:08:05

by Danilo Krummrich

Subject: [PATCH] drm/gpuvm: doc: fix filename references

Commit f72c2db47080 ("drm/gpuvm: rename struct drm_gpuva_manager to
struct drm_gpuvm") did also change the corresponding filenames which are
referenced from the documentation, but were not adjusted accordingly.
Hence, fix up those filenames.

Fixes: f72c2db47080 ("drm/gpuvm: rename struct drm_gpuva_manager to struct drm_gpuvm")
Reported-by: Stephen Rothwell <[email protected]>
Closes: https://lore.kernel.org/dri-devel/[email protected]/
Signed-off-by: Danilo Krummrich <[email protected]>
---
Documentation/gpu/drm-mm.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
index c19b34b1c0ed..602010cb6894 100644
--- a/Documentation/gpu/drm-mm.rst
+++ b/Documentation/gpu/drm-mm.rst
@@ -466,40 +466,40 @@ DRM MM Range Allocator Function References
.. kernel-doc:: drivers/gpu/drm/drm_mm.c
:export:

-DRM GPU VA Manager
-==================
+DRM GPUVM
+=========

Overview
--------

-.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
+.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
:doc: Overview

Split and Merge
---------------

-.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
+.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
:doc: Split and Merge

Locking
-------

-.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
+.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
:doc: Locking

Examples
--------

-.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
+.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
:doc: Examples

-DRM GPU VA Manager Function References
---------------------------------------
+DRM GPUVM Function References
+-----------------------------

-.. kernel-doc:: include/drm/drm_gpuva_mgr.h
+.. kernel-doc:: include/drm/drm_gpuvm.h
:internal:

-.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
+.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
:export:

DRM Buddy Allocator
--
2.41.0

2023-09-27 08:15:32

by Dave Airlie

Subject: Re: [PATCH] drm/gpuvm: doc: fix filename references

On Tue, 26 Sept 2023 at 20:52, Danilo Krummrich <[email protected]> wrote:
>
> Commit f72c2db47080 ("drm/gpuvm: rename struct drm_gpuva_manager to
> struct drm_gpuvm") did also change the corresponding filenames which are
> referenced from the documentation, but were not adjusted accordingly.
> Hence, fix up those filenames.

Acked-by: Dave Airlie <[email protected]>

>
> Fixes: f72c2db47080 ("drm/gpuvm: rename struct drm_gpuva_manager to struct drm_gpuvm")
> Reported-by: Stephen Rothwell <[email protected]>
> Closes: https://lore.kernel.org/dri-devel/[email protected]/
> Signed-off-by: Danilo Krummrich <[email protected]>
> ---
> Documentation/gpu/drm-mm.rst | 20 ++++++++++----------
> 1 file changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> index c19b34b1c0ed..602010cb6894 100644
> --- a/Documentation/gpu/drm-mm.rst
> +++ b/Documentation/gpu/drm-mm.rst
> @@ -466,40 +466,40 @@ DRM MM Range Allocator Function References
> .. kernel-doc:: drivers/gpu/drm/drm_mm.c
> :export:
>
> -DRM GPU VA Manager
> -==================
> +DRM GPUVM
> +=========
>
> Overview
> --------
>
> -.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
> +.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
> :doc: Overview
>
> Split and Merge
> ---------------
>
> -.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
> +.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
> :doc: Split and Merge
>
> Locking
> -------
>
> -.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
> +.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
> :doc: Locking
>
> Examples
> --------
>
> -.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
> +.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
> :doc: Examples
>
> -DRM GPU VA Manager Function References
> ---------------------------------------
> +DRM GPUVM Function References
> +-----------------------------
>
> -.. kernel-doc:: include/drm/drm_gpuva_mgr.h
> +.. kernel-doc:: include/drm/drm_gpuvm.h
> :internal:
>
> -.. kernel-doc:: drivers/gpu/drm/drm_gpuva_mgr.c
> +.. kernel-doc:: drivers/gpu/drm/drm_gpuvm.c
> :export:
>
> DRM Buddy Allocator
> --
> 2.41.0
>