openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
linux/Documentation/media/uapi/mediactl/media-controller.rst

55 lines
924 B
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: media-controller.rst: add missing copy symbol Just like V4L and DVB parts, add the copyright symbol. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 04:01:31 +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
.. _media_controller:
[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 IV - Media Controller API
##############################
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 08:25:36 +08:00
.. only:: html
.. class:: toc-title
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
[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
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: media-controller: fix conversion issues Make it look just like v4l and DVB parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 03:55:06 +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
media-controller-intro
media-controller-model
media-types
[media] doc-rst: Group function references together for MC Just like the other parts of the media book, group the MC functions together on one chapter. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-10 06:58:33 +08:00
media-funcs
[media] doc-rst: add media.h header to media contrller 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 19:54:35 +08:00
media-header
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 and Copyright
**********************
doc-rst: media-controller: fix conversion issues Make it look just like v4l and DVB parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 03:55:06 +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: media-controller: fix conversion issues Make it look just like v4l and DVB parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 03:55:06 +08:00
- Pinchart, Laurent <laurent.pinchart@ideasonboard.com>
- Initial version.
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: media-controller: missing credits When I wrote the MC next gen patches, I also improved the media controller documentation and added documentation for MEDIA_IOC_G_TOPOLOGY, but I forgot to add the credits on that time. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 03:58:53 +08:00
- Carvalho Chehab, Mauro <mchehab@kernel.org>
- MEDIA_IOC_G_TOPOLOGY documentation and documentation improvements.
doc-rst: media-controller.rst: add missing copy symbol Just like V4L and DVB parts, add the copyright symbol. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 04:01:31 +08:00
**Copyright** |copy| 2010 : Laurent Pinchart
**Copyright** |copy| 2015-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: media-controller: fix conversion issues Make it look just like v4l and DVB parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 03:55:06 +08:00
****************
Revision History
****************
doc-rst: media-controller: missing credits When I wrote the MC next gen patches, I also improved the media controller documentation and added documentation for MEDIA_IOC_G_TOPOLOGY, but I forgot to add the credits on that time. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 03:58:53 +08:00
:revision: 1.1.0 / 2015-12-12 (*mcc*)
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: 1.0.0 / 2010-11-10 (*lp*)
Initial revision