The ioctl is declared twice. This causes the following warning:
	/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/vidioc-g-edid:7:
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The asterisks cause parsing warnings with Sphinx:
	Documentation/linux_tv/media/dvb/fe_property_parameters:954: WARNING: Inline substitution_reference start-string without end-string.
	/devel/v4l/patchwork/Documentation/linux_tv/media/dvb/fe_property_parameters:993: WARNING: Inline emphasis start-string without end-string.

On the first warning, the ISDB-T layer enabled description is a
kind of ackward. Improve it.

For the second one, IMHO, it is clearer to use [A-C], as it
shows what are the real possibilities, than using asterisk.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Unescaped * causes warnings on Sphinx.

Add an escape at hist-v4l2 occurrences.

At libv4l-introduction, the best is do declare the function
prototypes as C code.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion didn't add blank lines where needed, but it
added were it weren't ;)

Fix it, to make it to parse correctly by Sphinx. This also
fixes a bunch or warnings:
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:44: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:52: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:58: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:71: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:78: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:84: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:107: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are lots of warnings there:

/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:74: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:89: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:168: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:183: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:206: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:216: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:292: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:308: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:393: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:478: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:657: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:735: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:746: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:822: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:833: ERROR: Unexpected indentation.

Also, sometimes the :sup: tag was ignored. Fix it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Fix Sphinx those warnings:
	WARNING: undefined label: fdl-modified>`as given on the :ref:`title page <fdl-title-page (if the link has no caption the label must precede a section header)
	WARNING: undefined label: v4l2-pix-fmt-yuv420 (if the link has no caption the label must precede a section $
	WARNING: undefined label: pixfmt-srggb10 (if the link has no caption the label must precede a section heade$
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

On several places, instead of using references, the code was
using some other tag. Not sure if this was due to the conversion,
or if something were already wrong on the DocBook. In any case,
let's fix them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

All error codes should be const. Most are, but there are
lots of places where we forgot to add <constant> at the DocBook.

Fix those via this small script:
	for i in $(git grep -lE "\s+E[A-Z]+\b" Documentation/linux_tv/); do perl -ne 's,([^\`])\b(E[A-Z]+)\b,\1``\2``,g; print $_' <$i >a && mv a $i; done

As there are false positives, we needed to merge only the changes
that make sense, skipping the c blocks and skipping things like
EDID, EN, ETS that were also converted by the above code.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The example captions got stripped by the conversion to ReST.
Re-add.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

On the example captions, use always <chapter>.<number>., because:
1) it matches the DocBook;
2) it would mean less changes if we need to add a new example,
as only one chapter will be affected.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The ReST markup is limited: it doesn't accept a const just
after a reference. So, change the documentation to avoid such
constraint.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion on this file didn't end too well. fix the found
issues:

1) Sphinix seems to not allow things like *foo :ref:`bar`*. At least
on this document, it did the wrong thing. So, change the logic to
something that will work fine with ReST format;

2) Some ioctl pointers were not looking nice;

3) the captions on the examples got discarded;

4) The notes specific to each example were not converted well.
Again, we'll need to replace it for a simpler design, as Sphinx
is a way more limited than DocBook.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There is a missing escape caracter, causing troubles at the
format of one of the paragraphs. Also, the ioctl description
was producing some warnings about wrong identation.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The c language parser checks if there are duplicated object
definitions. That causes lots of warnings like:
	WARNING: duplicate C object description of ioctl

Let's remove those by telling Sphinx that the language for
those objects are c++. The look of the descriptions will
be close, and the warnings will be gone.

Please notice that we had to keep a few of them as C, as
the c++ parser seems to be broken when it finds an enum.

Yet, this reduced from 219 warnings to 143, with is
a good thing.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This chapter is referenced on several parts of the extended
controls. Change the title to make it nicer where it is
referenced.

Ok, we might, instead, just change the name for the references
to only mention the oldest ioctl, but IMHO, it is better to
keep the name of all ioctls where it is referenced.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of using a constant, use references, just like the
other references for ioctl's.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion broke references and captions for examples.

Fix the missing reference for control enumeration.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Those got removed by the doc conversion.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This auto-generated file is bogus: it just adds a toc for two
other files. Instead, just move the controls and extended-controls
directly to the common file.

this avoids a blank page, and better organize the document.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Those got lost during format conversion.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The captions were lost during the format conversion.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

As VIDIOC_G_foo is the reference used for VIDIOC_S_foo and
VIDIOC_TRY_foo, we need to explicitly name the reference, as
otherwise, it will mention the three ioctls altogether, with
is not what we want.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There were lots of consts at the media docbook that should
be, instead, references. Convert the ones that can easily
be done by an automatic script.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are lots of internal references in the form:
	:ref:`foo <foo>`

Simplify them to be just: :ref:`foo`.

Patch generated via this small script:

for j in $(find . -name '*'); do echo $j; perl -ne 'if (m/\`(\S+)\s*\<(\S+)\>\`/) { if (!($1=~'http') && $1 eq $2) { s,\s*\<(\S+)\>,,; } } print $_' <$j >a && mv a $j; done
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Due to a limitation at the DocBook language, the references
were using lowercase and slashes, instead of the name of the
ioctls. On ReST, make them identical. This will hopefully
help to cleanup the code a little bit.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are several constants there that should be, instead,
cross-references. Fix them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are two examples in the code, but the captions of them
were lost during the ReST conversion. Manually add them again.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The Video4Linux documentation is big. We want to numerate the
items, as it makes easier to reference an item while discussing
the document on meetings.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of using const, transform it into a reference.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

What should be a reference to VIDIOC_S_PRIORITY was incorrectly
defined as a constant at the DocBook. Fix it on the rst version.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Make easier to navigate at the media document by adding the
links to each of the parts of the document.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This is not due to the format change, but there are some
wrong references on this file. Fix them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion of the authors and revision history lists
didn't end too well.

Manually fix them.

The revision history still needs some care in the future.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Fix some issues from the conversion and improve the documentation
a little bit, by adding two relevent keywords (SDR and DTMB).
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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

This is the restructuredText (reST) migration of the ``media``
DocBook-XML set from the linux_tv project.
Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

* 'docs-next' of git://git.lwn.net/linux: (64 commits)
  Add .pyc files to .gitignore
  Doc: PM: Fix a typo in intel_powerclamp.txt
  doc-rst: flat-table directive - initial implementation
  Documentation: add meta-documentation for Sphinx and kernel-doc
  Documentation: tiny typo fix in usb/gadget_multi.txt
  Documentation: fix wrong value in md.txt
  bcache: documentation formatting, edited for clarity, stripe alignment notes
  bcache: documentation updates and corrections
  Documentation: add top level 'make help' output for Sphinx
  Documentation/sphinx: drop modindex, we don't have python modules
  Documentation/sphinx: add support for specifying extra export files
  Documentation/sphinx: use a more sensible string split in kernel-doc extension
  Documentation/sphinx: remove unnecessary temporary variable
  kernel-doc: unify all EXPORT_SYMBOL scanning to one place
  kernel-doc: add support for specifying extra files for EXPORT_SYMBOLs
  kernel-doc: abstract filename mapping
  kernel-doc: add missing semi-colons in option parsing
  kernel-doc: do not warn about duplicate default section names
  kernel-doc: remove old debug cruft from dump_section()
  docs: kernel-doc: Add "example" and "note" to the magic section types
  ...

Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This patch fix a spelling typo in intel_powerclamp.txt
Signed-off-by: NMasanari Iida <standby24x7@gmail.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Implements the reST flat-table directive.

The ``flat-table`` is a double-stage list similar to the ``list-table`` with
some additional features:

* column-span: with the role ``cspan`` a cell can be extended through
  additional columns

* row-span: with the role ``rspan`` a cell can be extended through
  additional rows

* auto span rightmost cell of a table row over the missing cells on the right
  side of that table-row.  With Option ``:fill-cells:`` this behavior can
  changed from *auto span* to *auto fill*, which automaticly inserts (empty)

list tables

  The *list tables* formats are double stage lists. Compared to the
  ASCII-art they migth be less comfortable for readers of the
  text-files. Their advantage is, that they are easy to create/modify
  and that the diff of a modification is much more meaningfull, because
  it is limited to the modified content.

The initial implementation was taken from the sphkerneldoc project [1]

[1] https://github.com/return42/sphkerneldoc/commits/master/scripts/site-python/linuxdoc/rstFlatTable.pySigned-off-by: NMarkus Heiser <markus.heiser@darmarIT.de>
[jc: fixed typos and misspellings in the docs]
Signed-off-by: NJonathan Corbet <corbet@lwn.net>