AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2024-12-25 19:55:28 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity
0aea6d5c5b
linux_dsm_epyc7002/Documentation/userspace-api/media/dvb/dvbapi.rst

127 lines
2.9 KiB
ReStructuredText
Raw Normal View History

media: add SPDX header to media uAPI files All those files are under GFDL 1.1 or later, with no invariant sections. Tag them as such. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-08-30 21:15:26 +07:00
.. Permission is granted to copy, distribute and/or modify this
.. document under the terms of the GNU Free Documentation License,
.. Version 1.1 or any later version published by the Free Software
.. Foundation, with no Invariant Sections, no Front-Cover Texts
.. and no Back-Cover Texts. A copy of the license is included at
media: docs: move uAPI book to userspace-api/media Since 2017, there is an space reserved for userspace API, created by changeset 1d596dee3862 ("docs: Create a user-space API guide"). As the media subsystem was one of the first subsystems to use Sphinx, until this patch, we were keeping things on a separate place. Let's just use the new location, as having all uAPI altogether will likely make things easier for developers. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 16:21:39 +07:00
.. Documentation/userspace-api/media/fdl-appendix.rst.
media: add SPDX header to media uAPI files All those files are under GFDL 1.1 or later, with no invariant sections. Tag them as such. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-08-30 21:15:26 +07:00
..
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
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 02:33:35 +07: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 20:18:56 +07: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 20:36:18 +07: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 18:16:07 +07: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 03:49:50 +07:00
.. note::
media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" The usage of the term "DVB" at the dvb API docs is confusing, as, right now, it can refer to either the European digital TV standard or to the subsystem. So, prefer calling it as "Digital TV" on most places, to avoid ambiguity. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:28:16 +07:00
This API is also known as Linux **DVB API**.
It it was originally written to support the European digital TV
standard (DVB), and later extended to support all digital TV standards.
In order to avoid confusion, within this document, it was opted to refer to
it, and to associated hardware as **Digital TV**.
The word **DVB** is reserved to be used for:
- the Digital TV API version
(e. g. DVB API version 3 or DVB API version 5);
- digital TV data types (enums, structs, defines, etc);
- digital TV device nodes (``/dev/dvb/...``);
- the European DVB standard.
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 20:18:56 +07:00
**Version 5.10**
media: docs: don't show ToC for each part on PDF output The "Table of Contents" of a PDF file is generated only once, at the beginning fo the output. It doesn't produce it on each part. So, don't output this text on each part of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-03 07:25:36 +07:00
.. only:: html
.. class:: toc-title
[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 20:36:18 +07:00
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 20:18:56 +07: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 20:36:18 +07: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 01:59:52 +07: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 20:18:56 +07:00
intro
frontend
demux
ca
net
legacy_dvb_apis
examples
media: dvb uapi docs: better organize header files Instead of having one chapter per file, place all of them at the same chapter. That better organize the chapters at the uAPI documentation. As a side effect, now all uAPI headers are at the same page, at the html output, with makes easier to use it as a reference index for the spec. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 21:02:23 +07:00
headers
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 20:18:56 +07:00
**********************
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 01:59:52 +07: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 20:18:56 +07: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 01:59:52 +07: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 20:18:56 +07:00
media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" The usage of the term "DVB" at the dvb API docs is confusing, as, right now, it can refer to either the European digital TV standard or to the subsystem. So, prefer calling it as "Digital TV" on most places, to avoid ambiguity. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:28:16 +07:00
- Original author of the Digital TV 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 20:18:56 +07: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 01:59:52 +07: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 20:18:56 +07:00
media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" The usage of the term "DVB" at the dvb API docs is confusing, as, right now, it can refer to either the European digital TV standard or to the subsystem. So, prefer calling it as "Digital TV" on most places, to avoid ambiguity. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:28:16 +07:00
- Original author of the Digital TV API documentation.
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 01:59:52 +07:00
media: update/fix my e-mail on some places There are two places pointing to an unexisting "m.chehab@kernel.org" email. I never had such email, so, I'm unsure how it ends there. Anyway, it is plain wrong. While here, use my canonical e-mail on a bunch of places that are pointing to another e-mail. The idea is that, from now on, all places will be pointing to the same SMTP server. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-05-10 18:15:24 +07:00
- Carvalho Chehab, Mauro <mchehab+samsung@kernel.org>
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 01:59:52 +07:00
- 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 20:18:56 +07:00
media: dvbapi.rst: add an entry to DVB revision history There are several missing items at the API history. Yet, as we're doing a significant change there, add a new entry. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:32:44 +07:00
**Copyright** |copy| 2009-2017 : 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 20:18:56 +07: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 01:59:52 +07:00
****************
Revision History
****************
media: dvbapi.rst: add an entry to DVB revision history There are several missing items at the API history. Yet, as we're doing a significant change there, add a new entry. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:32:44 +07:00
:revision: 2.2.0 / 2017-09-01 (*mcc*)
Most gaps between the uAPI document and the Kernel implementation
got fixed for the non-legacy API.
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 20:18:56 +07: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
media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" The usage of the term "DVB" at the dvb API docs is confusing, as, right now, it can refer to either the European digital TV standard or to the subsystem. So, prefer calling it as "Digital TV" on most places, to avoid ambiguity. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:28:16 +07:00
Digital TV API.
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 20:18:56 +07:00
:revision: 2.0.4 / 2011-05-06 (*mcc*)
media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" The usage of the term "DVB" at the dvb API docs is confusing, as, right now, it can refer to either the European digital TV standard or to the subsystem. So, prefer calling it as "Digital TV" on most places, to avoid ambiguity. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 23:28:16 +07:00
Add more information about DVBv5 API, better describing the frontend
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 20:18:56 +07:00
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.
Reference in New Issue Copy Permalink