diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-01 12:28:16 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-05 06:18:03 -0400 |
| commit | 699f19e3f1e84e7e0ce3b2be7ceafe4ce99b606e (patch) | |
| tree | 5bad64214364bbfd057562637a6ca2cc67e18e30 /Documentation/media/uapi/dvb/dvbapi.rst | |
| parent | 0de6357aca39e28118edde71216ef44af7fddc39 (diff) | |
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>
Diffstat (limited to 'Documentation/media/uapi/dvb/dvbapi.rst')
| -rw-r--r-- | Documentation/media/uapi/dvb/dvbapi.rst | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/Documentation/media/uapi/dvb/dvbapi.rst b/Documentation/media/uapi/dvb/dvbapi.rst index 9ca3dd24bd7d..268bf69db281 100644 --- a/Documentation/media/uapi/dvb/dvbapi.rst +++ b/Documentation/media/uapi/dvb/dvbapi.rst @@ -10,8 +10,21 @@ 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. + 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. **Version 5.10** @@ -41,11 +54,11 @@ Authors: - J. K. Metzler, Ralph <rjkm@metzlerbros.de> - - Original author of the DVB API documentation. + - Original author of the Digital TV API documentation. - O. C. Metzler, Marcus <rjkm@metzlerbros.de> - - Original author of the DVB API documentation. + - Original author of the Digital TV API documentation. - Carvalho Chehab, Mauro <m.chehab@kernel.org> @@ -63,11 +76,11 @@ Revision History 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. +Digital TV API. :revision: 2.0.4 / 2011-05-06 (*mcc*) -Add more information about DVB APIv5, better describing the frontend +Add more information about DVBv5 API, better describing the frontend GET/SET props ioctl's. |