UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity
OpenCloudOS-Kernel/Documentation/admin-guide/media/index.rst

125 lines
2.1 KiB
ReStructuredText
Raw Normal View History

media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08:00
.. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
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 20:44:56 +08:00
============================
Media subsystem usage guides
============================
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08: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 20:44:56 +08:00
This section contains usage information about media subsystem and
its supported drivers.
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08: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 20:44:56 +08:00
Please see:
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08: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 20:44:56 +08:00
- :doc:`/userspace-api/media/index`
for the userspace APIs used on media devices.
- :doc:`/driver-api/media/index`
for driver development information and Kernel APIs used by
media devices;
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08:00
.. _uapi-v4l-drivers:
################################################
Video4Linux (V4L) driver-specific documentation
################################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
media: admin-guide: Add an introduction chapter The media's admin guide is currently just a group of not-connected docs. Add an introduction chapter for it to start making sense to a random reader. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-16 19:31:40 +08:00
intro
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08:00
cardlist
v4l-with-ir
bttv
cafe_ccic
cpia2
cx88
davinci-vpbe
fimc
imx
imx7
ipu3
ivtv
meye
omap3isp
omap4_camera
philips
qcom_camss
rcar-fdp1
saa7134
si470x
si4713
si476x
vimc
vivid
##############################################
Linux Digital TV driver-specific documentation
##############################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
media: docs: intro.rst actually contain DVB references This document doesn't describe the DVB subsystem. Instead, it just contain references to some places. Better name it and improve its contents. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-09 21:56:54 +08:00
dvb_intro
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08:00
ci
faq
media: docs: intro.rst actually contain DVB references This document doesn't describe the DVB subsystem. Instead, it just contain references to some places. Better name it and improve its contents. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-09 21:56:54 +08:00
dvb_references
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08:00
media: docs: intro.rst actually contain DVB references This document doesn't describe the DVB subsystem. Instead, it just contain references to some places. Better name it and improve its contents. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-09 21:56:54 +08:00
cards
media: docs: move user-facing docs to the admin guide Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-03-04 20:08:03 +08:00
avermedia
bt8xx
lmedm04
opera-firmware
technisat
ttusb-dec
zr364xx
#################################
CEC driver-specific documentation
#################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
pulse8-cec
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 20:34:29 +08:00
**Copyright** |copy| 1999-2020 : LinuxTV Developers
::
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.