doc: gpu: drm-internals: Create reference to DRM mm
Subsystems (3)
PATCH 1/1 doc: gpu: drm-internals: Create reference to DRM mm
This short sentence references nothing for details about memory manager. Replace it with the documentation file for DRM memory management.
--- Documentation/gpu/drm-internals.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/gpu/drm-internals.rst +2 -2
@@ -126,8 +126,8 @@ Memory Manager Initialization Every DRM driver requires a memory manager which must be initialized at load time. DRM currently contains two memory managers, the Translation Table Manager (TTM) and the Graphics Execution Manager (GEM). This -document describes the use of the GEM memory manager only. See ? for -details. +document describes the use of the GEM memory manager only. See +Documentation/gpu/drm-mm.rst for details. Miscellaneous Device Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.33.0
Quoted 14 lines · Markus Schneider-Pargmann
This short sentence references nothing for details about memory manager. Replace it with the documentation file for DRM memory management.
Cc Jani Nikula <[email protected]>Signed-off-by Markus Schneider-Pargmann <[email protected]>--- Documentation/gpu/drm-internals.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/gpu/drm-internals.rst +0
-0
Documentation/gpu/drm-internals.rst Memory Manager Initialization · line 130
Quoted 7 lines
Documentation/gpu/drm-internals.rst +2
-2@@ -126,8 +126,8 @@ Memory Manager Initialization Every DRM driver requires a memory manager which must be initialized at load time. DRM currently contains two memory managers, the Translation Table Manager (TTM) and the Graphics Execution Manager (GEM). This -document describes the use of the GEM memory manager only. See ? for -details. +document describes the use of the GEM memory manager only. See +Documentation/gpu/drm-mm.rst for details.
Please use rst references instead of a file reference.
BR,
Jani.
Quoted 3 lines
Documentation/gpu/drm-internals.rst +0
-0Miscellaneous Device Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
Jani Nikula, Intel Open Source Graphics Center
Hi Jani,
Quoted 10 lines · Jani Nikula
Quoted 9 lines · Markus Schneider-Pargmann
This short sentence references nothing for details about memory manager. Replace it with the documentation file for DRM memory management.
Cc Jani Nikula <[email protected]>Signed-off-by Markus Schneider-Pargmann <[email protected]>--- Documentation/gpu/drm-internals.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Quoted 14 lines
Documentation/gpu/drm-internals.rst Memory Manager Initialization · line 130
Quoted 12 lines
Documentation/gpu/drm-internals.rst +2
-2@@ -126,8 +126,8 @@ Memory Manager Initialization Every DRM driver requires a memory manager which must be initialized at load time. DRM currently contains two memory managers, the Translation Table Manager (TTM) and the Graphics Execution Manager (GEM). This -document describes the use of the GEM memory manager only. See ? for -details. +document describes the use of the GEM memory manager only. See +Documentation/gpu/drm-mm.rst for details.Please use rst references instead of a file reference.
Thanks for your comment. Could you please explain it a bit more to me?
I am new to the kernel sphinx documentation so I looked it up in Documentation/doc-guide/sphinx.rst 'Cross-referencing'. It is listed as the preferred way to reference other documents if I understand it correctly.
Should the doc-guide be updated then if a rst reference is preferred?
Best,
Markus
Quoted 28 lines · Markus Schneider-Pargmann
Hi Jani,
Quoted 10 lines · Jani Nikula
Quoted 9 lines · Markus Schneider-Pargmann
This short sentence references nothing for details about memory manager. Replace it with the documentation file for DRM memory management.
Cc Jani Nikula <[email protected]>Signed-off-by Markus Schneider-Pargmann <[email protected]>--- Documentation/gpu/drm-internals.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Quoted 14 lines
Documentation/gpu/drm-internals.rst Memory Manager Initialization · line 130
Quoted 12 lines
Documentation/gpu/drm-internals.rst +2
-2@@ -126,8 +126,8 @@ Memory Manager Initialization Every DRM driver requires a memory manager which must be initialized at load time. DRM currently contains two memory managers, the Translation Table Manager (TTM) and the Graphics Execution Manager (GEM). This -document describes the use of the GEM memory manager only. See ? for -details. +document describes the use of the GEM memory manager only. See +Documentation/gpu/drm-mm.rst for details.Please use rst references instead of a file reference.
Quoted 8 lines
Thanks for your comment. Could you please explain it a bit more to me?
I am new to the kernel sphinx documentation so I looked it up in
Documentation/doc-guide/sphinx.rst'Cross-referencing'. It is listed as the preferred way to reference other documents if I understand it correctly.Should the doc-guide be updated then if a rst reference is preferred?
Please go with what the doc-guide says, sorry for the noise.
BR,
Jani.
Signature · 1 line
Jani Nikula, Intel Open Source Graphics Center