renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-23 20:53:53 +08:00
Code
d8bc60a90d
linux-next/Documentation/media/uapi/dvb/dvbapi.rst

105 lines
1.9 KiB
ReStructuredText
Raw Normal View History

doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
.. -*- coding: utf-8; mode: rst -*-
doc-rst: linuxt_tv: update the documentation year The RST version was produced in 2016. So, update it where it was still pointing to the wrong year. While here, added the missing (copyright) symbols. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 03:33:35 +08:00
.. include:: <isonum.txt>
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
.. _dvbapi:
[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>
2016-07-20 21:36:18 +08:00
########################
Part II - Digital TV API
########################
doc-rst: Rename the title of the Digital TV section The Digital TV section is ackward for two reasons: 1) it is the only one with everything in upper case; 2) its name is associated with the European digital TV standard. Rename the part name, and add a notice that it refers to what's known as "DVB API". Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 19:16:07 +08:00
[media] docs-rst: better use the .. note:: tag Change multi-line note tags to be more symetric, e. g. not starting the text together witht the tag. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-16 04:49:50 +08:00
.. note::
This API is also known as **DVB API**, although it is generic
[media] doc-rst: improve display of notes and warnings There are several notes and warning mesages in the middle of the media docbook. Use the ReST tags for that, as it makes them visually better and hightlights them. While here, modify a few ones to make them clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-10 22:57:43 +08:00
enough to support all digital TV standards.
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
**Version 5.10**
[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>
2016-07-20 21:36:18 +08:00
.. class:: toc-title
Table of Contents
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
.. toctree::
[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>
2016-07-20 21:36:18 +08:00
:maxdepth: 5
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
:numbered:
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
intro
frontend
demux
ca
net
legacy_dvb_apis
examples
audio_h
ca_h
dmx_h
frontend_h
net_h
video_h
**********************
Revision and Copyright
**********************
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
Authors:
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
- J. K. Metzler, Ralph <rjkm@metzlerbros.de>
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
- Original author of the DVB API documentation.
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
- O. C. Metzler, Marcus <rjkm@metzlerbros.de>
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
- Original author of the DVB API documentation.
- Carvalho Chehab, Mauro <m.chehab@kernel.org>
- Ported document to Docbook XML, addition of DVBv5 API, documentation gaps fix.
**Copyright** |copy| 2002-2003 : Convergence GmbH
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: linuxt_tv: update the documentation year The RST version was produced in 2016. So, update it where it was still pointing to the wrong year. While here, added the missing (copyright) symbols. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 03:33:35 +08:00
**Copyright** |copy| 2009-2016 : Mauro Carvalho Chehab
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: dvbapi: Fix conversion issues The conversion of this file didn't happen too well. We want the items numbered, and format it just like what we did with part 1 of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:59:52 +08:00
****************
Revision History
****************
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
:revision: 2.1.0 / 2015-05-29 (*mcc*)
DocBook improvements and cleanups, in order to document the system calls
on a more standard way and provide more description about the current
DVB API.
:revision: 2.0.4 / 2011-05-06 (*mcc*)
Add more information about DVB APIv5, better describing the frontend
GET/SET props ioctl's.
:revision: 2.0.3 / 2010-07-03 (*mcc*)
Add some frontend capabilities flags, present on kernel, but missing at
the specs.
:revision: 2.0.2 / 2009-10-25 (*mcc*)
documents FE_SET_FRONTEND_TUNE_MODE and
FE_DISHETWORK_SEND_LEGACY_CMD ioctls.
:revision: 2.0.1 / 2009-09-16 (*mcc*)
Added ISDB-T test originally written by Patrick Boettcher
:revision: 2.0.0 / 2009-09-06 (*mcc*)
Conversion from LaTex to DocBook XML. The contents is the same as the
original LaTex version.
:revision: 1.0.0 / 2003-07-24 (*rjkm*)
Initial revision on LaTEX.
Copy Permalink