microsoft
/
WSL2-Linux-Kernel
зеркало из https://github.com/microsoft/WSL2-Linux-Kernel.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
WSL2-Linux-Kernel/Documentation/userspace-api/media/index.rst

73 строки
2.0 KiB
ReStructuredText
Исходник Обычный вид История

media: docs: brainless mass add SPDX headers to all media files All Documentation files outside the uAPI are all licensed with, at least, GPL 2.0. So, mark them as such. The ondes at media/uapi are at least GFDL 1.1+. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-08-30 17:20:04 +03:00
.. SPDX-License-Identifier: GPL-2.0
doc-rst: linuxt_tv: update the documentation year The RST version was produced in 2016. So, update it where it was still pointing to the wrong year. While here, added the missing (copyright) symbols. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 22:33:35 +03:00
.. include:: <isonum.txt>
[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 21:01:20 +03:00
########################################
Linux Media Infrastructure userspace API
########################################
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 16:18:56 +03:00
media: docs: add cros-references to the other media guides In order to make easier for people to navigate between the three media guides, add cross-references between them Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-31 15:44:56 +03:00
This section contains the driver development information and Kernel APIs
used by media devices.
Please see:
media: docs: */media/index.rst: don't use ReST doc:`foo` The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2021-06-05 15:00:54 +03:00
Documentation/admin-guide/media/index.rst
media: docs: add cros-references to the other media guides In order to make easier for people to navigate between the three media guides, add cross-references between them Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-31 15:44:56 +03:00
media: docs: */media/index.rst: don't use ReST doc:`foo` The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2021-06-05 15:00:54 +03:00
- for usage information about media subsystem and supported drivers;
Documentation/driver-api/media/index.rst
- for driver development information and Kernel APIs used by
media devices;
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 16:18:56 +03:00
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 03:25:36 +03:00
.. only:: html
.. class:: toc-title
[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 18:35:08 +03: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 16:18:56 +03: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 16:36:18 +03:00
:maxdepth: 1
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 16:18:56 +03:00
[media] doc-rst: media: reordered top sectioning Within the old section hierarchy, all doc parts has been placed under the introduction, e.g: * Linux Media Infrastructure API + Introduction - Video for Linux API - Digital TV API - ... With separating the introduction sibling to the other parts we get a more common section hierarchy: * Linux Media Infrastructure API + Introduction + Video for Linux API + Digital TV API + ... BTW: compacting the intro text. This patch is on top of media_tree/docs-next Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
2016-07-09 18:06:26 +03:00
intro
media: docs: move uAPI book to userspace-api/media Since 2017, there is an space reserved for userspace API, created by changeset 1d596dee3862 ("docs: Create a user-space API guide"). As the media subsystem was one of the first subsystems to use Sphinx, until this patch, we were keeping things on a separate place. Let's just use the new location, as having all uAPI altogether will likely make things easier for developers. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 12:21:39 +03:00
v4l/v4l2
dvb/dvbapi
rc/remote_controllers
mediactl/media-controller
cec/cec-api
gen-errors
media: docs: add glossary.rst with common terms used at V4L2 spec Add a glossary of terms used within the media userspace API documentation, as several concepts are complex enough to cause misunderstandings. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2017-08-25 17:49:32 +03:00
glossary
media: docs: move uAPI book to userspace-api/media Since 2017, there is an space reserved for userspace API, created by changeset 1d596dee3862 ("docs: Create a user-space API guide"). As the media subsystem was one of the first subsystems to use Sphinx, until this patch, we were keeping things on a separate place. Let's just use the new location, as having all uAPI altogether will likely make things easier for developers. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 12:21:39 +03:00
fdl-appendix
media: docs: add an uAPI chapter for driver-specific stuff There are some uAPI stuff that are driver-specific. Add them to the main media uAPI body. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-06 10:50:46 +03:00
drivers/index
media: docs: move copyrights to the end and update them The copyright info is not the most valuable information there. Move them to the end. While here, change the copyright to cover up to this year (2020). Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-31 15:34:29 +03:00
**Copyright** |copy| 2009-2020 : LinuxTV Developers
::
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, with no
Invariant Sections. A copy of the license is included in the chapter
entitled "GNU Free Documentation License".
media: docs: add GPLv2 for uAPI guide Newer uAPI docs should be dual-licensed with both GPL and GFDL. Add a text adding the GPLv2 license text there, in order to be coherent with the included docs. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-31 15:44:49 +03:00
Please notice that some documents inside the media userspace API,
when explicitly mentioned on its source code, are dual-licensed
with GNU Free Documentation License Version 1.1 and with the
GNU General Public License::
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.