OpenSDV
/
original_kernel
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
original_kernel/Documentation/media/media_kapi.rst

35 lines
949 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 19:22:23 +08: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 18:20:06 +08: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 19:22:23 +08: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 18:20:06 +08: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-19 02:01:20 +08: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 18:20:06 +08: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 19:22:23 +08: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 18:20:06 +08:00
[media] doc-rst: Fix license for the media books The kAPI, v4l-drivers and dvb-drivers never used the GNU FDL license. The addition of such license header were just due to copy-and-paste. So, let's fix it. As the media_kapi were part of device-drivers.tmp, it is under GPL v2+. The other two books is an agregation of files without any license explicitly specified. So, they're all bound to the Kernel's COPYING license. So, they're GPL v2 only. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-20 22:27:17 +08:00
This documentation is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option) any
later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
For more details see the file COPYING in the source distribution of Linux.
[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 18:20:06 +08: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 23:35:08 +08: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 19:22:23 +08: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-19 02:01:20 +08: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 18:20:06 +08: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 19:22:23 +08:00
kapi/v4l2-core
kapi/dtv-core
kapi/rc-core
kapi/mc-core