redonkable
/
alistair23-linux
1
0
Fork 0
Code Releases Activity
alistair23-linux/Documentation/media/media_kapi.rst

32 lines
751 B
ReStructuredText
Raw Normal View History

[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 05:22:23 -06:00
.. -*- coding: utf-8; mode: rst -*-
[media] doc-rst: Convert media API to rst Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 04:20:06 -06:00
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 05:22:23 -06:00
.. include:: <isonum.txt>
[media] doc-rst: Convert media API to rst Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 04:20:06 -06:00
[media] doc-rst: better name the media books The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 12:01:20 -06:00
===================================
Media subsystem kernel internal API
===================================
[media] doc-rst: Convert media API to rst Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 04:20:06 -06:00
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 05:22:23 -06:00
**Copyright** |copy| 2009-2016 : LinuxTV Developers
[media] doc-rst: Convert media API to rst Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 04:20:06 -06:00
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 05:22:23 -06: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. A copy of
the license is included in the chapter entitled "GNU Free Documentation
License".
[media] doc-rst: Convert media API to rst Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 04:20:06 -06:00
[media] doc-rst: backward compatibility with older Sphinx versions Sphinx is really evil when an older version finds an extra attribute for the :toctree: tag: it simply ignores everything and produce documents without any chapter inside! As we're now using tags available only on Sphinx 1.4.x, we need to use some creative ways to add a title before the table of contents. Do that by using a css class. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-19 09:35:08 -06:00
.. class:: toc-title
Table of Contents
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 05:22:23 -06:00
.. toctree::
:maxdepth: 5
[media] doc-rst: better name the media books The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 12:01:20 -06:00
:numbered:
[media] doc-rst: Convert media API to rst Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 04:20:06 -06:00
[media] doc-rst: move framework docs to kAPI documentation Those documentation are part of the kAPI one. Move to the right place. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 12:19:48 -06:00
kapi/v4l2-framework
kapi/v4l2-controls
[media] doc-rst: Convert videobuf documentation to ReST The videobuf documentation is almost at rst format: we just needed to add titles and add some code-blocks there and that's it. Also, add a notice that this framework is deprecated. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 12:58:51 -06:00
kapi/videobuf
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 05:22:23 -06:00
kapi/v4l2-core
kapi/dtv-core
kapi/rc-core
kapi/mc-core