* [PATCH] doc: gpu: drm-internals: Create reference to DRM mm
@ 2021-09-20 10:13 Markus Schneider-Pargmann
2021-09-20 11:01 ` Jani Nikula
0 siblings, 1 reply; 5+ messages in thread
From: Markus Schneider-Pargmann @ 2021-09-20 10:13 UTC (permalink / raw)
To: Daniel Vetter, David Airlie
Cc: dri-devel, linux-doc, Markus Schneider-Pargmann, Jani Nikula
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@intel.com>
Signed-off-by: Markus Schneider-Pargmann <msp@baylibre.com>
---
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.
Miscellaneous Device Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.33.0
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: gpu: drm-internals: Create reference to DRM mm
2021-09-20 10:13 [PATCH] doc: gpu: drm-internals: Create reference to DRM mm Markus Schneider-Pargmann
@ 2021-09-20 11:01 ` Jani Nikula
2021-09-20 14:03 ` Markus Schneider-Pargmann
0 siblings, 1 reply; 5+ messages in thread
From: Jani Nikula @ 2021-09-20 11:01 UTC (permalink / raw)
To: Markus Schneider-Pargmann, Daniel Vetter, David Airlie
Cc: dri-devel, linux-doc, Markus Schneider-Pargmann
On Mon, 20 Sep 2021, Markus Schneider-Pargmann <msp@baylibre.com> 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@intel.com>
> Signed-off-by: Markus Schneider-Pargmann <msp@baylibre.com>
> ---
> 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.
BR,
Jani.
>
> Miscellaneous Device Configuration
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
Jani Nikula, Intel Open Source Graphics Center
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: gpu: drm-internals: Create reference to DRM mm
2021-09-20 11:01 ` Jani Nikula
@ 2021-09-20 14:03 ` Markus Schneider-Pargmann
2021-09-21 9:58 ` Jani Nikula
0 siblings, 1 reply; 5+ messages in thread
From: Markus Schneider-Pargmann @ 2021-09-20 14:03 UTC (permalink / raw)
To: Jani Nikula; +Cc: Daniel Vetter, David Airlie, dri-devel, linux-doc
Hi Jani,
On Mon, Sep 20, 2021 at 02:01:57PM +0300, Jani Nikula wrote:
> On Mon, 20 Sep 2021, Markus Schneider-Pargmann <msp@baylibre.com> 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@intel.com>
> > Signed-off-by: Markus Schneider-Pargmann <msp@baylibre.com>
> > ---
> > 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?
Best,
Markus
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: gpu: drm-internals: Create reference to DRM mm
2021-09-20 14:03 ` Markus Schneider-Pargmann
@ 2021-09-21 9:58 ` Jani Nikula
0 siblings, 0 replies; 5+ messages in thread
From: Jani Nikula @ 2021-09-21 9:58 UTC (permalink / raw)
To: Markus Schneider-Pargmann
Cc: Daniel Vetter, David Airlie, dri-devel, linux-doc
On Mon, 20 Sep 2021, Markus Schneider-Pargmann <msp@baylibre.com> 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@baylibre.com> 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@intel.com>
>> > Signed-off-by: Markus Schneider-Pargmann <msp@baylibre.com>
>> > ---
>> > 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
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH] doc: gpu: drm-internals: Create reference to DRM mm
@ 2021-08-11 7:42 Markus Schneider-Pargmann
0 siblings, 0 replies; 5+ messages in thread
From: Markus Schneider-Pargmann @ 2021-08-11 7:42 UTC (permalink / raw)
To: Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann
Cc: linux-doc, Markus Schneider-Pargmann, Jani Nikula
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@intel.com>
Signed-off-by: Markus Schneider-Pargmann <msp@baylibre.com>
---
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.
Miscellaneous Device Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.32.0
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2021-09-21 9:58 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-20 10:13 [PATCH] doc: gpu: drm-internals: Create reference to DRM mm Markus Schneider-Pargmann
2021-09-20 11:01 ` Jani Nikula
2021-09-20 14:03 ` Markus Schneider-Pargmann
2021-09-21 9:58 ` Jani Nikula
-- strict thread matches above, loose matches on Subject: below --
2021-08-11 7:42 Markus Schneider-Pargmann
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.