Commit Graph

602155 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab 2287cb47fb [media] doc-rst: move bttv documentation to bttv.rst file
There were several files under Documentation/video4linux/bttv.

Instead of simply copying them to the rst folder, I opted to
merge into a single document and adjust the headers to
adjust the section levels and fix the cards tables.

There are two exceptions on the merge:

- The Tuners were renamed as a separate document, as they
  describe a separate driver;

- I removed the PROBLEMS section. It describes problems with
  the very first generation of 3D boards (Mistique/S3).
  It sounds very unlikely that someone would still need to
  install a bttv board on such hardware. Also, it is not
  very well written, IMHO.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 10:04:48 -03:00
Mauro Carvalho Chehab 2e97d6d301 [media] v4l-with-ir.rst: update it to reflect the current status
This document were really old. Update it to reflect the current
status of the IR drivers for TV.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:28 -03:00
Mauro Carvalho Chehab 31cae7ca8d [media] doc-rst: add documentation about IR on V4L boards
This section is outdated, but let's add it, after converting
to ReST, and then fix it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:28 -03:00
Mauro Carvalho Chehab cff4c8acf2 [media] doc-rst: add vivid documentation
Convert it to ReST and add to media/v4l-drivers book.

As the sections here (and on other docs) are numbered,
let's also make this book auto-numbered.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:27 -03:00
Mauro Carvalho Chehab 7200e68967 [media] doc-rst: add documentation for Zoran driver
Convert it to ReST and add to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:26 -03:00
Mauro Carvalho Chehab a965d2024f [media] doc-rst: add documentation for uvcvideo
Convert it to ReST and add to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:26 -03:00
Mauro Carvalho Chehab c0d0138255 [media] doc-rst: add soc-camera documentation
Convert it to ReST format and add it at media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:25 -03:00
Mauro Carvalho Chehab f1668f1d13 [media] doc-rst: add documentation for si476x
Convert it to ReST and add to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:16 -03:00
Mauro Carvalho Chehab b299357065 [media] doc-rst: add documentation for si4713
Convert it to ReST and add it to the media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:16 -03:00
Mauro Carvalho Chehab b4a41387be [media] doc-rst: add documentation for si470x
Convert it to ReST and add to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:15 -03:00
Mauro Carvalho Chehab 9cbfcd7cf2 [media] doc-rst: add sh_mobile_ceu_camera crop documentation
Convert it to ReST and add it to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:14 -03:00
Mauro Carvalho Chehab ae9d2873a8 [media] doc-rst: add documentation for saa7134
Convert it to ReST and add to the media/v4l-device book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:51:06 -03:00
Mauro Carvalho Chehab 6286d2b185 [media] doc-rst: add documentation for radiotrack
Convert it to ReST and add it to the media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:50:02 -03:00
Mauro Carvalho Chehab f0bb8dd9ba [media] doc-rst: add pxa_camera documentation
Convert pxa_camera to ReST format and add it to the
media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:50:01 -03:00
Mauro Carvalho Chehab 1bb6f32af7 [media] doc-rst: add documentation for pvrusb2
Convert pvrusb2 documentation to ReST file and removed the note
about an html version of the documentation, as it is not
shipped inside the Kernel.

Add it to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:50:01 -03:00
Mauro Carvalho Chehab 93db50d6ec [media] doc-rst: add omap4_camera documentation
Convert the omap4_camera documentation to ReST and add it to
the media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:50:00 -03:00
Mauro Carvalho Chehab b956109303 [media] doc-rst: add omap3isp documentation
Convert omap3isp documentation to ReST and add it to the
media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:50:00 -03:00
Mauro Carvalho Chehab c90495fe1e [media] doc-rst: add meye documentation
Convert the meye documentation to rst and add it to the
media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:59 -03:00
Mauro Carvalho Chehab 2a744b0d7b [media] doc-rst: Add ivtv documentation
Convert ivtv documentation to rst, update the links there
and add to media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:59 -03:00
Mauro Carvalho Chehab f0726e4275 [media] doc-rst: add documentation for fimc driver
Convert the document to rst and add it to the v4l-drivers
book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:58 -03:00
Mauro Carvalho Chehab e0f104538c [media] doc-rst: add davinci-vpbe documentation
Convert it to rst format and add it to the v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:57 -03:00
Mauro Carvalho Chehab 55aa32feb0 [media] cx88.rst: Update the documentation
This doc is outdated, and contains information that it is not
true anymore. Update it to reflect the changes that this
driver suffered since I started working on it.

While here, also update Gerd's name.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:57 -03:00
Mauro Carvalho Chehab c009e6819e [media] doc-rst: Add cx88 documentation to media book
Convert the cx88 documentation to rst and add it to the v4l-devices
book

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:56 -03:00
Mauro Carvalho Chehab ba9f270e01 [media] doc-rst: add documentation for cpia2 driver
Convert the documentation to rst, merge the two files and
add to the index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:49:56 -03:00
Mauro Carvalho Chehab f3d295c5e2 [media] doc-rst: add Zoran zr364xx documentation
Convert the documentation to rst and add it to the book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:41:15 -03:00
Mauro Carvalho Chehab 8b2f4b39ef [media] doc-rst: add gspca cardlist
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:41:14 -03:00
Mauro Carvalho Chehab 8f6174a07e [media] doc-rst: convert cafe_ccic file to rst format
This file is almost ok, but it needs chapter/sections
and a code-block.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:41:13 -03:00
Mauro Carvalho Chehab 00748947f9 [media] doc-rst: convert fourcc to rst format
Fix fourcc for it to be correcly parsed by Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:41:13 -03:00
Mauro Carvalho Chehab 70c95242c4 [media] doc-rst: Move v4l docs to media/v4l-drivers
Move V4L documentation files to media/v4l-drivers. Those aren't
core stuff, so they don't fit at the kAPI document.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 22:41:07 -03:00
Mauro Carvalho Chehab bde8bea759 doc-rst: add v4l-drivers to index file
Adds documentation for V4L drivers.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 16:30:37 -03:00
Mauro Carvalho Chehab 1bed13f521 [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 16:30:36 -03:00
Mauro Carvalho Chehab 9488fed623 [media] doc-rst: move videobuf documentation to media/kapi
This document describes a kapi framework. Move it to the right
place.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 16:30:36 -03:00
Mauro Carvalho Chehab 4c21d4fb1b [media] doc-rst: do a poor man's conversion of v4l2-framework
Make Sphinx happy with v4l2-framework.rst by putting all C
code inside code-block.

Please note that this is a poor man ReST conversion, as several
of those blocks should actually be converted to use :cpp:func:,
pointing to the kAPI auto-generated documentation.

The problem is that we currently lack kernel-doc documentation
for most of the stuff described there.

So, let's do a poor man's conversion. We should later address
this.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 16:30:35 -03:00
Mauro Carvalho Chehab f6ebc2d341 [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 16:30:35 -03:00
Mauro Carvalho Chehab 92effdf8b8 [media] doc-rst: Remove deprecated API.html document
This document points to some old stuff. Just remove it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 16:30:34 -03:00
Mauro Carvalho Chehab d5d84447ba [media] doc-rst: move cardlists to media/v4l-drivers
Convert the cardlists to ReST format and move them to
Documentation/media/v4l-drivers/

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 16:30:33 -03:00
Mauro Carvalho Chehab d8e9230c2e [media] extract_xc3028.pl: move it to scripts/dir
This doesn't belong at documentation. Move it to scripts.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:08:12 -03:00
Mauro Carvalho Chehab 651af5e464 [media] add DVB documentation to Sphinx
Now that all DVB files got converted, add it to Sphinx
build.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:55 -03:00
Mauro Carvalho Chehab 70e8d3e999 [media] doc-rst: convert udev chapter to rst
This chapter is outdated. I almost removed, but, as we're lacking
documentation about how to make DVB devices persistent, I opted,
instead, to keep it, and add a note about that.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:54 -03:00
Mauro Carvalho Chehab d91b11bfdb [media] doc-rst: convert ttusb-dev to rst
There are some things that needed to be done to convert
it to ReST. Also, there are some obsolete info there
related to Kernels 2.4 and 2.6. Update them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:53 -03:00
Mauro Carvalho Chehab 63dd837ec0 [media] doc-rst: Convert technisat document to ReST
This document need some changes to be properly parsed by
Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:53 -03:00
Mauro Carvalho Chehab 6e31b7c117 [media] doc-rst: add opera-firmware.rst to DVB docs
This file is shown OK with ReST. Yet, as we changed the
place where the get_dvb_firmware script is, we need to
update it.

While here, move the author's name to the beginning of the
file.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:52 -03:00
Mauro Carvalho Chehab 683ac0ea8e [media] doc-rst: Convert lmedm04 to rst format
This file was missing a name for the index, and weren't
using any markup language. Make it looks better and
convert to ReST.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:51 -03:00
Mauro Carvalho Chehab c0be9f7952 [media] doc-rst: convert DVB FAQ to ReST format
Convert the DVB FAQ to ReST format and add a note that this is
outdated.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:51 -03:00
Mauro Carvalho Chehab 9bb2c55a79 [media] doc-rst: Convert dvb-usb to ReST format
This file is not on any markup language. Convert it to
ReST format.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:50 -03:00
Mauro Carvalho Chehab dee74db3d1 [media] doc-rst: Convert contributors list to ReST
The contributors list needs some adjustments to be properly
formatted.

Also, this list has not been updated for a while. So, add a
notice about that.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:49 -03:00
Mauro Carvalho Chehab c1eaa6c478 [media] doc-rst: Convert ci.txt to a rst file
The old ci.txt file had a very peculiar format, with doesn't
match any markup language I know. Change it to be on ReST
format, for it to be parsed by Sphinx.

Also, as this is an old document, add a note about it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:49 -03:00
Mauro Carvalho Chehab 986fd9a9ed [media] doc-rst: convert cards to rst format
This file is using a markup-like language, but it is not quite
ReST. Convert it, and add a note pointing to the Wiki page with
the known supported hardware devices.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:48 -03:00
Mauro Carvalho Chehab d61da478b3 [media] doc-rst: convert bt8xx doc to rst
This document almost follows a markup language, but it is
not ReST. Fix it to be handled by Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:47 -03:00
Mauro Carvalho Chehab d3686003e0 [media] doc-rst: Fix format of avermedia.rst
This file is almost at the ReST format, but some things need
to be fixed for it to be parsed.

Also, the documentation there is old. So, add a notice about
that.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:47 -03:00