References at the rst files for C functions generated via
kernel-doc should use :c:func:.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Reorganize the order of the document, putting the chapters
on a more logical order and renaming some sections.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Now that the only remaining chapters at v4l2-framework are
the introduction ones, let' s rename the file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Move the v4l2 clocks stuff from v4l2-framework to a separate
file and adds an attention that came from the v4l2-clk.h.
Note: as this is meant to be a temporary kAPI, and it is
used only by two drivers (soc_camera and em28xx), where
the first one is in deprecation process, it probably not
a worth effort to document its header.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Move the v4l2 event-specific text from v4l2-framework.rst
to v4l2-event.rst. That helps to keep the text together with
the functions it describes, and makes easier to identify
documentation gaps.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
As we merged the videobuf chapter at the kABI section, and it
is a way more complete, just remove the small videobuf chapter
that came from framework.txt.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Add cross-references for the functions/structs and add
the markup tags to improve its display.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Add documentation for v4l2-dev.h, and put it at v4l2-framework.rst,
where struct video_device is currently documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
There are some subdev-specific functions at v4l2-common.h
that are mentioned at v4l2-subdev.rst.
Document them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
The two new sections were missing cross-references, and had
some other minor issues with the markups. Add such things.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
There are two additional subdev-specific sections at the
v4l2-framework file. Move them to the subdev chapter, in order
to better organize the book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Enrich the subdevice description by linking it to the
functions and structs from v4l2-subdev.h.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
There are lots of documentation about V4L2 subdevices at
v4l2-framework.rst. Move them to its specific chapter at
v4l2-subdev.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This document describes the main kAPI interfaces for the
v4l2-device.h header. Add cross references to the documentation
produced via kernel-doc.
While here, also use monotonic font for constants.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Part of the contents of v4l2-framework is related to the
kAPI defined by v4l2-device. Move such contents to the
v4l2-device.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Sphinx produce a 1:1 mapping between a rst file and an html file.
So, we need to split the kernel-doc tags on multiple documents.
A side effect is that we're now having a better name for each
section of the kAPI documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
The functions at v4l2-device.h are not using the proper
markups. Add it, and include at the v4l2-core.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
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>
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>
Fix all remaining media warnings with ReST that are fixable
without changing at the Sphinx code.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* patchwork: (1492 commits)
[media] cec: always check all_device_types and features
[media] cec: poll should check if there is room in the tx queue
[media] vivid: support monitor all mode
[media] cec: fix test for unconfigured adapter in main message loop
[media] cec: limit the size of the transmit queue
[media] cec: zero unused msg part after msg->len
[media] cec: don't set fh to NULL in CEC_TRANSMIT
[media] cec: clear all status fields before transmit and always fill in sequence
[media] cec: CEC_RECEIVE overwrote the timeout field
[media] cxd2841er: Reading SNR for DVB-C added
[media] cxd2841er: Reading BER and UCB for DVB-C added
[media] cxd2841er: fix switch-case for DVB-C
[media] cxd2841er: fix signal strength scale for ISDB-T
[media] cxd2841er: adjust the dB scale for DVB-C
[media] cxd2841er: provide signal strength for DVB-C
[media] cxd2841er: fix BER report via DVBv5 stats API
[media] mb86a20s: apply mask to val after checking for read failure
[media] airspy: fix error logic during device register
[media] s5p-cec/TODO: add TODO item
[media] cec/TODO: drop comment about sphinx documentation
...
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Update and expand the CEC documentation. Especially w.r.t. non-blocking
mode.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
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>
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>
I ended by adding twice each media header, because I saw some
missing stuff at the documents. It seems it was my mistake,
as everything seems to be there.
So, remove those extra stuff, to avoid duplicating the
documentation of the functions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Move the contents of this file to bttv.rst and saa7134.rst.
With that, we can finally remove Documentation/video4linux.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Import the contents of hauppauge-wintv-cx88-ir.txt, after
converted to ReST into cx88.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
There are some information about missing/wrong documentation at
cx231xx datasheet. Add it to the cx88 chapter.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Finally, adds the content of README.vbi at cx2341x.rst after
its conversion to ReST format.
Now, add information about this chipset and its driver is
inside a single chapter at the media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
The README.hm12 file describes the proprietary format used
by this driver for raw format, called HM12. Add its description
at the document, after converted to ReST.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Convert the contents of fw-decoder-registers.txt to ReST and
add it to cx2341x.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
move the contents of fw-decoder-api.txt to cx2341x and
convert it to ReST file, adding it to media/v4l-drivers
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
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>
