]> git.karo-electronics.de Git - karo-tx-linux.git/commitdiff
[media] doc-rst: better organize the media books
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 20 Jul 2016 13:36:18 +0000 (10:36 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Sat, 23 Jul 2016 11:03:24 +0000 (08:03 -0300)
The uAPI book has 5 parts, but they lost numeration after
conversion to rst. Manually number those parts, and make
the main index with 1 depth, to only show the parts and
the annexes.

At each part, use :maxwidth: 5, in order to show a more
complete index.

While here, fix the cross-references between different
books.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/kapi/mc-core.rst
Documentation/media/media_uapi.rst
Documentation/media/uapi/cec/cec-api.rst
Documentation/media/uapi/dvb/dvbapi.rst
Documentation/media/uapi/mediactl/media-controller.rst
Documentation/media/uapi/rc/remote_controllers.rst
Documentation/media/uapi/v4l/v4l2.rst
Documentation/media/v4l-drivers/fimc.rst

index c1fe0d69207dd190d25d56a751dc3a9bc52fbee1..4c47f5e3611da4dec11d1888a82110aefd57dab1 100644 (file)
@@ -5,7 +5,7 @@ Media Controller
 ~~~~~~~~~~~~~~~~
 
 The media controller userspace API is documented in
-:ref:`the Media Controller uAPI book <media_common>`. This document focus
+:ref:`the Media Controller uAPI book <media_controller>`. This document focus
 on the kernel-side implementation of the media framework.
 
 Abstract media device model
index aaa9a0e387c474b37fecb8503defceea2987417f..fd8ebe002cd200614722616cc0d1b089927b2877 100644 (file)
@@ -19,7 +19,7 @@ License".
         Table of Contents
 
 .. toctree::
-    :maxdepth: 5
+    :maxdepth: 1
 
     intro
     uapi/v4l/v4l2
index 246fbae2e079eb39a631e88764fbd12c2ba63092..bb018709970cf1ed504f44cc1854bf6643d0c0e1 100644 (file)
@@ -4,16 +4,18 @@
 
 .. _cec:
 
-#######
-CEC API
-#######
-
-.. _cec-api:
+#########################################
+Part V - Consumer Electronics Control API
+#########################################
 
 This part describes the CEC: Consumer Electronics Control
 
+.. class:: toc-title
+
+        Table of Contents
+
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 5
     :numbered:
 
     cec-intro
index 6c06147f167c20a686cc88ee800e939d0682d13c..48e61aba741e32a1cc4d4a501a5597143c1da264 100644 (file)
@@ -4,17 +4,21 @@
 
 .. _dvbapi:
 
-##############
-Digital TV API
-##############
+########################
+Part II - Digital TV API
+########################
 
 .. note:: This API is also known as **DVB API**, although it is generic
    enough to support all digital TV standards.
 
 **Version 5.10**
 
+.. class:: toc-title
+
+        Table of Contents
+
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 5
     :numbered:
 
     intro
index 7e08c93a15abd9e889518cac7eb827488fbcb9bd..7ae38d48969ea93300eed8a4f386e5a33787b91d 100644 (file)
@@ -2,21 +2,18 @@
 
 .. include:: <isonum.txt>
 
-.. _media_common:
-
-####################
-Media Controller API
-####################
-
 .. _media_controller:
 
-****************
-Media Controller
-****************
+##############################
+Part IV - Media Controller API
+##############################
+
+.. class:: toc-title
 
+        Table of Contents
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 5
     :numbered:
 
     media-controller-intro
index 169286501ebba815f64f5464d938673fa548e56b..3e25cc9f65e0a19638bdcccec5390d0c287c3d5c 100644 (file)
@@ -2,21 +2,18 @@
 
 .. include:: <isonum.txt>
 
-.. _remotes:
-
-#####################
-Remote Controller API
-#####################
-
 .. _remote_controllers:
 
-******************
-Remote Controllers
-******************
+################################
+Part III - Remote Controller API
+################################
+
+.. class:: toc-title
 
+        Table of Contents
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 5
     :numbered:
 
     rc-intro
index c0859ebc88ee30ccb76dcba9dadfe03e759e933b..5e41a85053013c82d391ddbef2239e94a1740aeb 100644 (file)
@@ -3,17 +3,21 @@
 .. include:: <isonum.txt>
 .. _v4l2spec:
 
-###################
-Video for Linux API
-###################
+############################
+Part I - Video for Linux API
+############################
 
 This part describes the Video for Linux API version 2 (V4L2 API) specification.
 
 **Revision 4.5**
 
+.. class:: toc-title
+
+        Table of Contents
+
 .. toctree::
     :numbered:
-    :maxdepth: 1
+    :maxdepth: 5
 
     common
     pixfmt
index d9f950d90eb5b63acea36514ce343a20e5fc4ea0..3adc19bcf03948ab28c389618d4d6cd9a91d2046 100644 (file)
@@ -62,8 +62,7 @@ User space interfaces
 Media device interface
 ~~~~~~~~~~~~~~~~~~~~~~
 
-The driver supports Media Controller API as defined at
-https://linuxtv.org/downloads/v4l-dvb-apis/media_common.html
+The driver supports Media Controller API as defined at :ref:`media_controller`.
 The media device driver name is "SAMSUNG S5P FIMC".
 
 The purpose of this interface is to allow changing assignment of FIMC instances
@@ -89,12 +88,11 @@ undefined behaviour.
 Capture video node
 ~~~~~~~~~~~~~~~~~~
 
-The driver supports V4L2 Video Capture Interface as defined at:
-https://linuxtv.org/downloads/v4l-dvb-apis/devices.html
+The driver supports V4L2 Video Capture Interface as defined at
+:ref:`devices`.
 
 At the capture and mem-to-mem video nodes only the multi-planar API is
-supported. For more details see:
-https://linuxtv.org/downloads/v4l-dvb-apis/planar-apis.html
+supported. For more details see: :ref:`planar-apis`.
 
 Camera capture subdevs
 ~~~~~~~~~~~~~~~~~~~~~~