[media] doc-rst: better organize the media books
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>
This commit is contained in:
parent
5b8700e9f9
commit
da83c888bf
|
@ -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
|
||||
|
|
|
@ -19,7 +19,7 @@ License".
|
|||
Table of Contents
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:maxdepth: 1
|
||||
|
||||
intro
|
||||
uapi/v4l/v4l2
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
Loading…
Reference in New Issue