[media] doc-rst: better name the media books
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Jul 2016 18:01:20 +0000 (15:01 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Jul 2016 18:01:20 +0000 (15:01 -0300)
The titles at the media books were misleading, and some books
were not numbered.

Rename the kAPI book to better reflect its contents, be more
consistent on the initial rst file for each book and better
name them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/index.rst
Documentation/media/dvb-drivers/index.rst
Documentation/media/media_drivers.rst [deleted file]
Documentation/media/media_kapi.rst [new file with mode: 0644]
Documentation/media/media_uapi.rst
Documentation/media/v4l-drivers/index.rst

index 31273cc..43c722f 100644 (file)
@@ -15,7 +15,7 @@ Contents:
 
    kernel-documentation
    media/media_uapi
-   media/media_drivers
+   media/media_kapi
    media/dvb-drivers/index
    media/v4l-drivers/index
 
index 14da36f..e1d4d87 100644 (file)
@@ -2,9 +2,9 @@
 
 .. include:: <isonum.txt>
 
-#############################################
-Linux Digital Video Broadcast (DVB) subsystem
-#############################################
+##############################################
+Linux Digital TV driver-specific documentation
+##############################################
 
 **Copyright** |copy| 2001-2016 : LinuxTV Developers
 
@@ -17,6 +17,9 @@ License".
 
 .. toctree::
        :maxdepth: 5
+       :numbered:
+       :caption: Table of Contents
+       :name: dvb_mastertoc
 
        intro
        avermedia
diff --git a/Documentation/media/media_drivers.rst b/Documentation/media/media_drivers.rst
deleted file mode 100644 (file)
index 8e0f455..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. include:: <isonum.txt>
-
-=========================
-Media subsystem core kAPI
-=========================
-
-**Copyright** |copy| 2009-2016 : LinuxTV Developers
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-any later version published by the Free Software Foundation. A copy of
-the license is included in the chapter entitled "GNU Free Documentation
-License".
-
-.. toctree::
-    :maxdepth: 5
-
-    kapi/v4l2-framework
-    kapi/v4l2-controls
-    kapi/videobuf
-    kapi/v4l2-core
-    kapi/dtv-core
-    kapi/rc-core
-    kapi/mc-core
diff --git a/Documentation/media/media_kapi.rst b/Documentation/media/media_kapi.rst
new file mode 100644 (file)
index 0000000..0af80e9
--- /dev/null
@@ -0,0 +1,29 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. include:: <isonum.txt>
+
+===================================
+Media subsystem kernel internal API
+===================================
+
+**Copyright** |copy| 2009-2016 : LinuxTV Developers
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1 or
+any later version published by the Free Software Foundation. A copy of
+the license is included in the chapter entitled "GNU Free Documentation
+License".
+
+.. toctree::
+    :maxdepth: 5
+    :numbered:
+    :caption: Table of Contents
+    :name: kapi_mastertoc
+
+    kapi/v4l2-framework
+    kapi/v4l2-controls
+    kapi/videobuf
+    kapi/v4l2-core
+    kapi/dtv-core
+    kapi/rc-core
+    kapi/mc-core
index 5e872c8..debe453 100644 (file)
@@ -2,9 +2,9 @@
 
 .. include:: <isonum.txt>
 
-##############################
-Linux Media Infrastructure API
-##############################
+########################################
+Linux Media Infrastructure userspace API
+########################################
 
 **Copyright** |copy| 2009-2016 : LinuxTV Developers
 
@@ -15,10 +15,10 @@ the license is included in the chapter entitled "GNU Free Documentation
 License".
 
 
-.. contents::
-
 .. toctree::
     :maxdepth: 5
+    :caption: Table of Contents
+    :name: uapi_mastertoc
 
     intro
     uapi/v4l/v4l2
index 34990b5..8d17102 100644 (file)
@@ -2,9 +2,9 @@
 
 .. include:: <isonum.txt>
 
-###########################
-Video4Linux (V4L) subsystem
-###########################
+################################################
+Video4Linux (V4L)  driver-specific documentation
+################################################
 
 **Copyright** |copy| 1999-2016 : LinuxTV Developers
 
@@ -18,6 +18,8 @@ License".
 .. toctree::
        :maxdepth: 5
        :numbered:
+       :caption: Table of Contents
+       :name: v4l_mastertoc
 
        fourcc
        v4l-with-ir