This document describes a kapi framework. Move it to the right
place.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Those documentation are part of the kAPI one. Move to the right
place.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This document points to some old stuff. Just remove it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Convert the cardlists to ReST format and move them to
Documentation/media/v4l-drivers/
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This doesn't belong at documentation. Move it to scripts.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Now that all DVB files got converted, add it to Sphinx
build.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This document need some changes to be properly parsed by
Sphinx.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Convert the DVB FAQ to ReST format and add a note that this is
outdated.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This file is not on any markup language. Convert it to
ReST format.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This document almost follows a markup language, but it is
not ReST. Fix it to be handled by Sphinx.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of keeping the introduction together with the
index, move it to a separate file, and add it via toctree
at the index.

The information there are outdated, so update it to point
to the right links.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are several documentation stuff under Documentation/dvb.

Move them to Documentation/media/dvb-drivers and rename them to
rst, as they'll soon be converted to rst files.

No changes at the documentation.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion from DocBook required some fixes:

- Now, the C files with the exported symbols also need to be
  added. So, all headers need to be included twice: one to
  get the structs/enums/.. and another one for the functions;

- Notes should use the ReST tag, as kernel-doc doesn't
  recognizes it anymore;

- Identation needs to be fixed, as ReST uses it to identify
  when a format "tag" ends.

- Fix the cross-references at the media controller description.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There were lots of issues at the media controller side,
after the conversion:

- Some documentation at the header files weren't using the
  kernel-doc start block;

- Now, the C files with the exported symbols also need to be
  added. So, all headers need to be included twice: one to
  get the structs/enums/.. and another one for the functions;

- Notes should use the ReST tag, as kernel-doc doesn't
  recognizes it anymore;

- Identation needs to be fixed, as ReST uses it to identify
  when a format "tag" ends.

- Fix the cross-references at the media controller description.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion from DocBook lead into some conversion issues,
basically due to the lack of proper support at kernel-doc.

So, address them:

- Now, the C files with the exported symbols also need to be
  added. So, all headers need to be included twice: one to
  get the structs/enums/.. and another one for the functions;

- Notes should use the ReST tag, as kernel-doc doesn't
  recognizes it anymore;

- Identation needs to be fixed, as ReST uses it to identify
  when a format "tag" ends.

- kernel-doc doesn't escape things like *pointer, so we
  need to manually add a escape char before it.

- On some cases, kernel-doc conversion requires violating
  the 80-cols, as otherwise it won't properly parse the
  source code.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The kernel-doc script is now broken if it doesn't find all
exported symbols documented.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Fix the paragraph identation for the media controller
headers.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The rst2pdf tool is a very broken toolchain, with is not capable
of parsing complex documents. As such, it doesn't build the
media book, failing with:

	[ERROR] pdfbuilder.py:130 too many values to unpack

(using rst2pdf version 0.93.dev-r0 and Sphinx version 1.4.5)

So, make it build only the books we know that are safe to build.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

--

Btw, with the standard Sphinx version shipped on Fedora 24 (Sphinx
1.3.1), rst2pdf doesn't build even the simple kernel-documentation,
failing with this error:
    writing Kernel... [ERROR] pdfbuilder.py:130 list index out of range

This is a known bug:
    https://github.com/sphinx-doc/sphinx/issues/1844

So, maybe we should just disable pdf generation from RST for good,
as I suspect that maintaining it with a broken toolchain will be a
big headache.

* 'docs-next' of git://git.lwn.net/linux:
  doc-rst: add an option to ignore DocBooks when generating docs
  workqueue: Fix a typo in workqueue.txt
  Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txt
  Documentation/sphinx: skip build if user requested specific DOCBOOKS
  Documentation: add cleanmediadocs to the documentation targets

Those fixes came from patchs from Andrea for the old DocBook
documentation.

As we're removing it on Kernel 4.8, it doesn't make sense to
apply the original patches, but, as the typos were ported
to ReST, let's fix the issues there.
Suggested-by: NAndrea Gelmini <andrea.gelmini@gelma.net>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

It is useful to have an index with all the book contents somewhere,
as it makes easier to seek for something. So, increase maxdepth
to 5 for the main index at the beginning of the book.

While here, remove the genindex content, as it is bogus.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

	Documentation/media/uapi/cec/cec-ioc-dqevent.rst:43: WARNING: undefined label: cec_event_state_change (if the link has no caption the label must precede a section header)
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Lots of fixups relating to references.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Fix those warnings:
	Documentation/output/videodev2.h.rst:6: WARNING: undefined label: vidioc_unsubscribe_event (if the link has no caption the label must precede a section header)
	Documentation/media/uapi/v4l/dev-overlay.rst:248: WARNING: Title underline too short.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This patch touches on places where it shouldn't: image
files and code examples. Also, it doesn't fix all array
occurrences.

So, let's revert it.

This reverts commit ffbab694.

The timestamp field was split into rx_ts and tx_ts, and the rx/tx_status
fields were moved. Update the doc accordingly.

Also fix a bug that stated that a non-zero tx_status field signaled an
error. That's not true, since TX_STATUS_OK is 1, not 0.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Those characters are used for citations. Better to escape, to
avoid them to be misinterpreted.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

According with ReST spec, footnotes should be like:
[#name], and not [name]. So, change them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Document V4L2_DV_PROGRESSIVE and V4L2_DV_INTERLACED and
fix missing references.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>