summaryrefslogtreecommitdiffstats
path: root/Documentation/media/media_uapi.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2016-07-09 12:06:26 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-09 12:23:07 -0300
commit6ec710e34d1c3179a374f4623e860a08c7b3326e (patch)
treedfbfbf45311ede7ee639ba6c5be0afe34362f0b2 /Documentation/media/media_uapi.rst
parentda98a79ba71fe62ae9f7581901df35ce0dc1be68 (diff)
downloadlinux-stable-6ec710e34d1c3179a374f4623e860a08c7b3326e.tar.gz
linux-stable-6ec710e34d1c3179a374f4623e860a08c7b3326e.tar.bz2
linux-stable-6ec710e34d1c3179a374f4623e860a08c7b3326e.zip
[media] doc-rst: media: reordered top sectioning
Within the old section hierarchy, all doc parts has been placed under the introduction, e.g: * Linux Media Infrastructure API + Introduction - Video for Linux API - Digital TV API - ... With separating the introduction sibling to the other parts we get a more common section hierarchy: * Linux Media Infrastructure API + Introduction + Video for Linux API + Digital TV API + ... BTW: compacting the intro text. This patch is on top of media_tree/docs-next Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Diffstat (limited to 'Documentation/media/media_uapi.rst')
-rw-r--r--Documentation/media/media_uapi.rst53
1 files changed, 1 insertions, 52 deletions
diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst
index 49f5cb5ed825..527c6deb1a19 100644
--- a/Documentation/media/media_uapi.rst
+++ b/Documentation/media/media_uapi.rst
@@ -15,61 +15,10 @@ the license is included in the chapter entitled "GNU Free Documentation
License".
-============
-Introduction
-============
-
-This document covers the Linux Kernel to Userspace API's used by video
-and radio streaming devices, including video cameras, analog and digital
-TV receiver cards, AM/FM receiver cards, Software Defined Radio (SDR),
-streaming capture and output devices, codec devices and remote controllers.
-
-A typical media device hardware is shown at
-:ref:`typical_media_device`.
-
-
-.. _typical_media_device:
-
-.. figure:: media_api_files/typical_media_device.*
- :alt: typical_media_device.svg
- :align: center
-
- Typical Media Device
-
-The media infrastructure API was designed to control such devices. It is
-divided into five parts.
-
-The :ref:`first part <v4l2spec>` covers radio, video capture and output,
-cameras, analog TV devices and codecs.
-
-The :ref:`second part <dvbapi>` covers the API used for digital TV and
-Internet reception via one of the several digital tv standards. While it
-is called as DVB API, in fact it covers several different video
-standards including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S,
-DTMB, etc. The complete list of supported standards can be found at
-:ref:`fe-delivery-system-t`.
-
-The :ref:`third part <remote_controllers>` covers the Remote Controller API.
-
-The :ref:`fourth part <media_controller>` covers the Media Controller API.
-
-The :ref:`fifth part <cec>` covers the CEC (Consumer Electronics Control) API.
-
-It should also be noted that a media device may also have audio
-components, like mixers, PCM capture, PCM playback, etc, which are
-controlled via ALSA API.
-
-For additional information and for the latest development code, see:
-`https://linuxtv.org <https://linuxtv.org>`__.
-
-For discussing improvements, reporting troubles, sending new drivers,
-etc, please mail to:
-`Linux Media Mailing List (LMML). <http://vger.kernel.org/vger-lists.html#linux-media>`__.
-
-
.. toctree::
:maxdepth: 1
+ intro
uapi/v4l/v4l2
uapi/dvb/dvbapi
uapi/rc/remote_controllers