On Mon, 20 Sep 2021, Markus Schneider-Pargmann <msp@xxxxxxxxxxxx> wrote: > Hi Jani, > > On Mon, Sep 20, 2021 at 02:01:57PM +0300, Jani Nikula wrote: >> On Mon, 20 Sep 2021, Markus Schneider-Pargmann <msp@xxxxxxxxxxxx> wrote: >> > This short sentence references nothing for details about memory manager. >> > Replace it with the documentation file for DRM memory management. >> > >> > Cc: Jani Nikula <jani.nikula@xxxxxxxxx> >> > Signed-off-by: Markus Schneider-Pargmann <msp@xxxxxxxxxxxx> >> > --- >> > Documentation/gpu/drm-internals.rst | 4 ++-- >> > 1 file changed, 2 insertions(+), 2 deletions(-) >> > >> > diff --git a/Documentation/gpu/drm-internals.rst b/Documentation/gpu/drm-internals.rst >> > index 06af044c882f..bdcdfc4ede04 100644 >> > --- a/Documentation/gpu/drm-internals.rst >> > +++ b/Documentation/gpu/drm-internals.rst >> > @@ -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? Please go with what the doc-guide says, sorry for the noise. BR, Jani. -- Jani Nikula, Intel Open Source Graphics Center
