UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity
OpenCloudOS-Kernel/Documentation/media/uapi/cec/cec-api.rst

42 lines
554 B
ReStructuredText
Raw Normal View History

[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
.. -*- coding: utf-8; mode: rst -*-
[media] doc-rst: reformat cec-api.rst Use the same format as the other parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 05:03:02 +08:00
.. include:: <isonum.txt>
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
.. _cec:
#######
CEC API
#######
.. _cec-api:
[media] doc-rst: make CEC look more like other parts of the book Better organize the contents of the CEC part, moving the introduction to chapter 1, placing all ioctls at chapter 2 and numerating all chapters and items. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 22:20:46 +08:00
This part describes the CEC: Consumer Electronics Control
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
.. toctree::
:maxdepth: 1
[media] doc-rst: make CEC look more like other parts of the book Better organize the contents of the CEC part, moving the introduction to chapter 1, placing all ioctls at chapter 2 and numerating all chapters and items. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 22:20:46 +08:00
:numbered:
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
[media] doc-rst: make CEC look more like other parts of the book Better organize the contents of the CEC part, moving the introduction to chapter 1, placing all ioctls at chapter 2 and numerating all chapters and items. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 22:20:46 +08:00
cec-intro
cec-funcs
[media] doc-rst: add CEC header file to the documentation Adding the header file is interesting for several reasons: 1) It makes MC documentation consistend with other parts; 2) The header file can be used as a quick index to all API elements; 3) The cross-reference check helps to identify symbols that aren't documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 21:25:05 +08:00
cec-header
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
**********************
Revision and Copyright
**********************
[media] doc-rst: reformat cec-api.rst Use the same format as the other parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 05:03:02 +08:00
Authors:
- Verkuil, Hans <hans.verkuil@cisco.com>
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
[media] doc-rst: reformat cec-api.rst Use the same format as the other parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 05:03:02 +08:00
- Initial version.
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
[media] doc-rst: reformat cec-api.rst Use the same format as the other parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 05:03:02 +08:00
**Copyright** |copy| 2016 : Hans Verkuil
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
[media] doc-rst: reformat cec-api.rst Use the same format as the other parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 05:03:02 +08:00
****************
Revision History
****************
[media] doc-rst: linux_tv CEC part, DocBook to reST migration This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 02:55:42 +08:00
:revision: 1.0.0 / 2016-03-17 (*hv*)
Initial revision