Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. cpp:function::

While here, use the same way we document man-like pages,
at the V4L side of the book and add escapes to asterisks.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

It also added an extra line on one of the texts, breaking
the original paragraph into two ones.

Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The right way to use it seems to do suscript is to use
this pattern: "\ :sub:"

Make sure all places of the media document will fit, by
using this script:

$n=0;
while (<>) {
	$n++;
	$t = $_;
	@matches = $t =~ m/(..\:sub\:)/g;
	foreach my $m (@matches) {
		$m =~ m/(.)(.)(\:sub\:)/;
		$s1=$1;
		$s2=$2;
		$s3=$3;
		next if (($s1 eq "\\") && ($s2 eq " "));
		if ($s2 eq " ") {
			$t =~ s/$s1$s2$s3/$s1\\$s2$s3/;
			next;
		}
		$t =~ s/$s1$s2$s3/$s1$s2\\ $s3/;
	}
	print $t;
}

And running it with:

for i in $(git grep -l sub Documentation/linux_tv/); do ./sub.pl $i >a && mv a $i; done
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

It also added an extra line on one of the texts, breaking
the original paragraph into two ones.

Remove them.

Finally, a space is required before :sub:, as otherwise it
won't display it right. Add it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added empty columns (probably, it was used on
DocBook just to increase spacing.

Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

It also added an extra line on one of the texts, breaking
the original paragraph into two ones.

Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added empty columns (probably, it was used on
DocBook just to increase spacing.

Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added empty columns (probably, it was used on
DocBook just to increase spacing.

Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.

Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The format conversion broke one paragraph into two. Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

The conversion script added some comments at the end.
They point to the original DocBook files, with will be
removed after the manual fixes. So, they'll be pointing
to nowere. So, remove those comments.

They'll be forever stored at the Kernel tree. So, if
someone wants the references, it is just a matter of
looking at the backlog.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

One paragraph mentions the YUV422 formats, but doesn't provide
a cross-ref. Add it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Constify the string "count" where it means a field.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Fix this Sphinx warning:
	Documentation/linux_tv/media/v4l/rw:31: WARNING: Literal block ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Fix those warnings:
	Documentation/linux_tv/media/v4l/open:38: WARNING: Literal block ends without a blank line; unexpected unindent.
	Documentation/linux_tv/media/v4l/open:45: WARNING: Literal block ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

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

The example captions got stripped by the conversion to ReST.
Re-add.
Signed-off-by: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>

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

The conversion broke references and captions for examples.

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

Those got removed by the doc conversion.
Signed-off-by: Mauro 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>

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

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