From patchwork Sat Jul 9 15:06:26 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Heiser X-Patchwork-Id: 35298 Received: from mail.tu-berlin.de ([130.149.7.33]) by www.linuxtv.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bLtqN-0003x0-U6; Sat, 09 Jul 2016 15:06:59 +0000 X-tubIT-Incoming-IP: 209.132.180.67 Received: from vger.kernel.org ([209.132.180.67]) by mail.tu-berlin.de (exim-4.84_2/mailfrontend-6) with esmtp id 1bLtqL-0001kT-5o; Sat, 09 Jul 2016 17:06:59 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751995AbcGIPGw (ORCPT + 1 other); Sat, 9 Jul 2016 11:06:52 -0400 Received: from smtp1.goneo.de ([85.220.129.30]:41558 "EHLO smtp1.goneo.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751897AbcGIPGv (ORCPT ); Sat, 9 Jul 2016 11:06:51 -0400 Received: from localhost (localhost [127.0.0.1]) by smtp1.goneo.de (Postfix) with ESMTP id 442B924108C; Sat, 9 Jul 2016 17:06:49 +0200 (CEST) X-Virus-Scanned: by goneo X-Spam-Flag: NO X-Spam-Score: -2.801 X-Spam-Level: X-Spam-Status: No, score=-2.801 tagged_above=-999 tests=[ALL_TRUSTED=-1, AWL=0.099, BAYES_00=-1.9] autolearn=unavailable Received: from smtp1.goneo.de ([127.0.0.1]) by localhost (smtp1.goneo.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 1FaQBx_8V-HH; Sat, 9 Jul 2016 17:06:39 +0200 (CEST) Received: from ubu1604.fritz.box (dyndsl-095-033-027-198.ewe-ip-backbone.de [95.33.27.198]) by smtp1.goneo.de (Postfix) with ESMTPSA id 1C21D24240B; Sat, 9 Jul 2016 17:06:39 +0200 (CEST) From: Markus Heiser To: Mauro Carvalho Chehab , Hans Verkuil , linux-media@vger.kernel.org Cc: Markus Heiser Subject: [PATCH RFC] doc-rst: media: reordered top sectioning Date: Sat, 9 Jul 2016 17:06:26 +0200 Message-Id: <1468076786-8594-1-git-send-email-markus.heiser@darmarit.de> X-Mailer: git-send-email 2.7.4 Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-PMX-Version: 6.0.0.2142326, Antispam-Engine: 2.7.2.2107409, Antispam-Data: 2016.7.9.145716 X-PMX-Spam: Gauge=IIIIIIII, Probability=8%, Report=' HTML_00_01 0.05, HTML_00_10 0.05, BODY_SIZE_5000_5999 0, BODY_SIZE_7000_LESS 0, LEGITIMATE_NEGATE 0, MULTIPLE_RCPTS_RND 0, URI_ENDS_IN_HTML 0, __ANY_URI 0, __CP_MEDIA_BODY 0, __CP_URI_IN_BODY 0, __FRAUD_COMMON 0, __FRAUD_REFNUM 0, __HAS_CC_HDR 0, __HAS_FROM 0, __HAS_MSGID 0, __HAS_X_MAILER 0, __HAS_X_MAILING_LIST 0, __HTTPS_URI 0, __INT_PROD_TV 0, __MIME_TEXT_ONLY 0, __MULTIPLE_URI_TEXT 0, __SANE_MSGID 0, __SUBJ_ALPHA_END 0, __TO_MALFORMED_2 0, __URI_IN_BODY 0, __URI_NO_WWW 0, __URI_NS , __URI_WITH_PATH 0' From: Markus Heiser 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 --- Documentation/media/intro.rst | 46 +++++++++++++++++++++++++++++++++ Documentation/media/media_uapi.rst | 53 +------------------------------------- 2 files changed, 47 insertions(+), 52 deletions(-) create mode 100644 Documentation/media/intro.rst diff --git a/Documentation/media/intro.rst b/Documentation/media/intro.rst new file mode 100644 index 0000000..be90bda --- /dev/null +++ b/Documentation/media/intro.rst @@ -0,0 +1,46 @@ +.. -*- coding: utf-8; mode: rst -*- + +============ +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. + +1. The :ref:`first part ` covers radio, video capture and output, + cameras, analog TV devices and codecs. + +2. The :ref:`second part ` 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`. + +3. The :ref:`third part ` covers the Remote Controller API. + +4. The :ref:`fourth part ` covers the Media Controller API. + +5. The :ref:`fifth part ` 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 `__. For discussing improvements, +reporting troubles, sending new drivers, etc, please mail to: `Linux Media +Mailing List (LMML) `__. diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst index 49f5cb5..527c6de 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 ` covers radio, video capture and output, -cameras, analog TV devices and codecs. - -The :ref:`second part ` 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 ` covers the Remote Controller API. - -The :ref:`fourth part ` covers the Media Controller API. - -The :ref:`fifth part ` 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 `__. - -For discussing improvements, reporting troubles, sending new drivers, -etc, please mail to: -`Linux Media Mailing List (LMML). `__. - - .. toctree:: :maxdepth: 1 + intro uapi/v4l/v4l2 uapi/dvb/dvbapi uapi/rc/remote_controllers