leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0d6821ec2f
linux/Documentation/media/uapi/cec/cec-api.rst

44 lines
691 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-08 18:55:42 +00: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-08 21:03:02 +00: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-08 18:55:42 +00:00
.. _cec:
[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 13:36:18 +00:00
#########################################
Part V - Consumer Electronics Control API
#########################################
[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-08 18:55:42 +00: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 14:20:46 +00: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-08 18:55:42 +00:00
[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 13:36:18 +00:00
.. class:: toc-title
Table of Contents
[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-08 18:55:42 +00: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 13:36:18 +00:00
:maxdepth: 5
[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 14:20:46 +00: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-08 18:55:42 +00: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 14:20:46 +00: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 13:25:05 +00: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-08 18:55:42 +00: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-08 21:03:02 +00: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-08 18:55:42 +00: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-08 21:03:02 +00: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-08 18:55:42 +00: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-08 21:03:02 +00: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-08 18:55:42 +00: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-08 21:03:02 +00: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-08 18:55:42 +00:00
:revision: 1.0.0 / 2016-03-17 (*hv*)
Initial revision
Reference in New Issue Copy Permalink