diff mbox

drm/doc: Put all driver docs into a separate chapter

Message ID 20180316075926.13584-1-daniel.vetter@ffwll.ch (mailing list archive)
State New, archived
Headers show

Commit Message

Daniel Vetter March 16, 2018, 7:59 a.m. UTC
We have quite a few driver docs now, which is great, but having them
all in the top-level gpu documentation chapter makes it harder to spot
the core/shared bits.

Stuff them into a separate chapter and ecourage people to add even
more!

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 Documentation/gpu/drivers.rst | 21 +++++++++++++++++++++
 Documentation/gpu/index.rst   |  9 +--------
 2 files changed, 22 insertions(+), 8 deletions(-)
 create mode 100644 Documentation/gpu/drivers.rst

Comments

Alex Deucher March 16, 2018, 7:24 p.m. UTC | #1
On Fri, Mar 16, 2018 at 3:59 AM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> We have quite a few driver docs now, which is great, but having them
> all in the top-level gpu documentation chapter makes it harder to spot
> the core/shared bits.
>
> Stuff them into a separate chapter and ecourage people to add even
> more!
>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>

Reviewed-by: Alex Deucher <alexander.deucher@amd.com>

> ---
>  Documentation/gpu/drivers.rst | 21 +++++++++++++++++++++
>  Documentation/gpu/index.rst   |  9 +--------
>  2 files changed, 22 insertions(+), 8 deletions(-)
>  create mode 100644 Documentation/gpu/drivers.rst
>
> diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
> new file mode 100644
> index 000000000000..e8c84419a2a1
> --- /dev/null
> +++ b/Documentation/gpu/drivers.rst
> @@ -0,0 +1,21 @@
> +========================
> +GPU Driver Documentation
> +========================
> +
> +.. toctree::
> +
> +   i915
> +   meson
> +   pl111
> +   tegra
> +   tinydrm
> +   tve200
> +   vc4
> +   bridge/dw-hdmi
> +
> +.. only::  subproject and html
> +
> +   Indices
> +   =======
> +
> +   * :ref:`genindex`
> diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst
> index c36586dad29d..00288f34c5a6 100644
> --- a/Documentation/gpu/index.rst
> +++ b/Documentation/gpu/index.rst
> @@ -10,16 +10,9 @@ Linux GPU Driver Developer's Guide
>     drm-kms
>     drm-kms-helpers
>     drm-uapi
> -   i915
> -   meson
> -   pl111
> -   tegra
> -   tinydrm
> -   tve200
> -   vc4
> +   drivers
>     vga-switcheroo
>     vgaarbiter
> -   bridge/dw-hdmi
>     todo
>
>  .. only::  subproject and html
> --
> 2.16.2
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Daniel Vetter March 19, 2018, 1:43 p.m. UTC | #2
On Fri, Mar 16, 2018 at 03:24:14PM -0400, Alex Deucher wrote:
> On Fri, Mar 16, 2018 at 3:59 AM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> > We have quite a few driver docs now, which is great, but having them
> > all in the top-level gpu documentation chapter makes it harder to spot
> > the core/shared bits.
> >
> > Stuff them into a separate chapter and ecourage people to add even
> > more!
> >
> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> 
> Reviewed-by: Alex Deucher <alexander.deucher@amd.com>

Applied, thanks for your review.
-Daniel

> 
> > ---
> >  Documentation/gpu/drivers.rst | 21 +++++++++++++++++++++
> >  Documentation/gpu/index.rst   |  9 +--------
> >  2 files changed, 22 insertions(+), 8 deletions(-)
> >  create mode 100644 Documentation/gpu/drivers.rst
> >
> > diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
> > new file mode 100644
> > index 000000000000..e8c84419a2a1
> > --- /dev/null
> > +++ b/Documentation/gpu/drivers.rst
> > @@ -0,0 +1,21 @@
> > +========================
> > +GPU Driver Documentation
> > +========================
> > +
> > +.. toctree::
> > +
> > +   i915
> > +   meson
> > +   pl111
> > +   tegra
> > +   tinydrm
> > +   tve200
> > +   vc4
> > +   bridge/dw-hdmi
> > +
> > +.. only::  subproject and html
> > +
> > +   Indices
> > +   =======
> > +
> > +   * :ref:`genindex`
> > diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst
> > index c36586dad29d..00288f34c5a6 100644
> > --- a/Documentation/gpu/index.rst
> > +++ b/Documentation/gpu/index.rst
> > @@ -10,16 +10,9 @@ Linux GPU Driver Developer's Guide
> >     drm-kms
> >     drm-kms-helpers
> >     drm-uapi
> > -   i915
> > -   meson
> > -   pl111
> > -   tegra
> > -   tinydrm
> > -   tve200
> > -   vc4
> > +   drivers
> >     vga-switcheroo
> >     vgaarbiter
> > -   bridge/dw-hdmi
> >     todo
> >
> >  .. only::  subproject and html
> > --
> > 2.16.2
> >
> > _______________________________________________
> > dri-devel mailing list
> > dri-devel@lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/dri-devel
diff mbox

Patch

diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
new file mode 100644
index 000000000000..e8c84419a2a1
--- /dev/null
+++ b/Documentation/gpu/drivers.rst
@@ -0,0 +1,21 @@ 
+========================
+GPU Driver Documentation
+========================
+
+.. toctree::
+
+   i915
+   meson
+   pl111
+   tegra
+   tinydrm
+   tve200
+   vc4
+   bridge/dw-hdmi
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst
index c36586dad29d..00288f34c5a6 100644
--- a/Documentation/gpu/index.rst
+++ b/Documentation/gpu/index.rst
@@ -10,16 +10,9 @@  Linux GPU Driver Developer's Guide
    drm-kms
    drm-kms-helpers
    drm-uapi
-   i915
-   meson
-   pl111
-   tegra
-   tinydrm
-   tve200
-   vc4
+   drivers
    vga-switcheroo
    vgaarbiter
-   bridge/dw-hdmi
    todo
 
 .. only::  subproject and html