Commit Graph

602065 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
8f764eb97c doc-rst: dmabuf: re-add the missing captions
The conversion from DocBook removed them. Re-add.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 16:31:20 -03:00
Mauro Carvalho Chehab
0579e6e3a3 doc-rst: linux_tv: remove whitespaces
Let's remove bad whitespaces on the entire book.

That helps to avoid mixing whitespace removal with other
patches.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 16:25:48 -03:00
Mauro Carvalho Chehab
a163ad5ceb doc-rst: userp: Add ioctl cross references
There are lots of ioctls mentioned there that aren't cross-referenced.

Convert the const to cross references. That makes it visually
better, and improves navigation along the document.

While here, remove bad whitespaces.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 16:20:02 -03:00
Mauro Carvalho Chehab
4eb96763e1 doc-rst: userp: re-add the missing captions
The conversion from DocBook removed them. Re-add.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 16:07:16 -03:00
Mauro Carvalho Chehab
6970f299db doc-rst: mmap: Add ioctl cross references
There are lots of ioctls mentioned there that aren't cross-referenced.

Convert the const to cross references. That makes it visually
better, and improves navigation along the document.

While here, remove bad whitespaces.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 16:07:15 -03:00
Mauro Carvalho Chehab
5c591aa13d doc-rst: mmap: re-add the missing captions
The conversion from DocBook removed them. Re-add.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 15:47:55 -03:00
Mauro Carvalho Chehab
afb392b1a4 doc-rst: pixfmt-nv16m: remove an empty column
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>
2016-07-04 14:22:27 -03:00
Mauro Carvalho Chehab
056d2ee6d2 doc-rst: v4l/pixfmt: re-join a broken paragraph
Originally, at the DocBook, the "Byte Order" were a single
paragraph with the string that follows it. The conversion
broke it, and, sometimes, it added an extra dot.

Fix them altogheter at pixfmt-*.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 13:58:01 -03:00
Mauro Carvalho Chehab
0b1e3cc001 doc-rst: pixfmt-nv16m: remove an empty column
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>
2016-07-04 13:51:02 -03:00
Mauro Carvalho Chehab
a23f41918a doc-rst: linux_tv: Fix a warning at lirc_dev_intro
Documentation/linux_tv/media/rc/lirc_dev_intro:17: WARNING: Inline substitution_reference start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 13:46:29 -03:00
Mauro Carvalho Chehab
b6967199c6 doc-rst: linux_tv: promote generic documents to the parent dir
The generic error codes and licensing sections are general to the
entire media book. They should not be inside the v4l dir. So,
promote them to the parent directory.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 13:37:29 -03:00
Mauro Carvalho Chehab
7322c84c8a doc-rst: linux_tv: move MC stuff to a separate dir
When we wrote the media controller's section, we re-used the
V4L, just because we were lazy to create a brand new DocBook.

Yet, it is a little ackward to have it mixed with V4L. So,
move it to its own directory, in order to have it better
organized.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 13:35:10 -03:00
Mauro Carvalho Chehab
f5eebeef99 doc-rst: linux_tv: move RC stuff to a separate dir
When we wrote the remote controller's section, we re-used the
V4L, just because we were lazy to create a brand new DocBook.

Yet, it is a little ackward to have it mixed with V4L. So,
move it to its own directory, in order to have it better
organized.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 13:33:04 -03:00
Mauro Carvalho Chehab
760c70102c doc-rst: linux_tv: avoid using c:func::
Using auto-generated links is dangerous, as there are multiple
definitions for syscalls (at least one on each book part).

So, reference them by their explicit reference.

I used this small script to help writing this patch:

for i in $(git grep -l "c:func:"); do perl -ne 's/\:c\:func:\`(open|close|read|poll|write|select|mmap|munmap|ioctl)\(\)`/:ref:`$1() <func-$1>`/; print $_' < $i >a && mv a $i; done

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 13:23:50 -03:00
Mauro Carvalho Chehab
5d2b3f1201 doc-rst: linux_tv: fix remaining lack of escapes
Add escape before asterisk to fix those warnings:

Documentation/linux_tv/media/dvb/FE_GET_EVENT:47: WARNING: Inline emphasis start-string without end-string.
Documentation/linux_tv/media/v4l/media-ioc-enum-links:78: WARNING: Inline emphasis start-string without end-string.
Documentation/linux_tv/media/v4l/media-ioc-enum-links:87: WARNING: Inline emphasis start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-04 12:46:04 -03:00
Mauro Carvalho Chehab
ad9de1abea doc-rst: FE_DISHNETWORK_SEND_LEGACY_CMD: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:42:14 -03:00
Mauro Carvalho Chehab
e3a54ab8ce doc-rst: FE_GET_EVENT: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:39:49 -03:00
Mauro Carvalho Chehab
d090484c76 doc-rst: FE_GET_FRONTEND: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:37:18 -03:00
Mauro Carvalho Chehab
9e1f61c057 doc-rst: FE_READ_BER: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:34:44 -03:00
Mauro Carvalho Chehab
5d468e2baf doc-rst: FE_READ_SIGNAL_STRENGTH: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:31:15 -03:00
Mauro Carvalho Chehab
6fcf645ec9 doc-rst: FE_READ_SNR: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:28:52 -03:00
Mauro Carvalho Chehab
9de499fe09 doc-rst: FE_READ_UNCORRECTED_BLOCKS: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:24:49 -03:00
Mauro Carvalho Chehab
d38395ab73 doc-rst: FE_SET_FRONTEND: improve man-like format
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c: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>
2016-07-04 12:22:51 -03:00
Mauro Carvalho Chehab
b1925f2e1c doc-rst: audio_function_calls: improve man-like format
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>
2016-07-04 12:15:56 -03:00
Mauro Carvalho Chehab
8f8724f9a2 doc-rst: ca_function_calls: improve man-like format
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>
2016-07-04 12:07:22 -03:00
Mauro Carvalho Chehab
c62252208f doc-rst: video_function_calls: improve man-like format
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>
2016-07-04 11:55:23 -03:00
Mauro Carvalho Chehab
94fff0dc53 doc-rst: dmx_fcalls: improve man-like format
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>
2016-07-04 11:54:05 -03:00
Mauro Carvalho Chehab
ce0b746b9e doc-rst: pixfmt-nv16: remove an empty column
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>
2016-07-04 10:06:33 -03:00
Mauro Carvalho Chehab
eba9e91c48 doc-rst: linux_tv: Fix some occurences of :sub:
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>
2016-07-04 10:02:02 -03:00
Mauro Carvalho Chehab
a678a50ecd doc-rst: pixfmt-nv12m: fix conversion issues
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>
2016-07-03 19:07:02 -03:00
Mauro Carvalho Chehab
31ad250f5f doc-rst: pixfmt-nv12: remove empty columns
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>
2016-07-03 18:55:19 -03:00
Mauro Carvalho Chehab
ff4fb88437 doc-rst: pixfmt-yuv411p: remove an empty column
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>
2016-07-03 18:49:18 -03:00
Mauro Carvalho Chehab
fb2ab1398d doc-rst: pixfmt-yuv422p: remove an empty column
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>
2016-07-03 18:44:59 -03:00
Mauro Carvalho Chehab
ee5c41dcdb doc-rst: pixfmt-yuv444m: remove empty columns
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>
2016-07-03 18:31:54 -03:00
Mauro Carvalho Chehab
85e2e3d91c doc-rst: pixfmt-yuv422m: remove an empty column
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>
2016-07-03 18:27:42 -03:00
Mauro Carvalho Chehab
8f10ed84e1 doc-rst: pixfmt-41p: remove empty columns
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>
2016-07-03 18:26:56 -03:00
Mauro Carvalho Chehab
d5d85a1b27 doc-rst: pixfmt-vyuy: remove an empty column
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>
2016-07-03 18:08:29 -03:00
Mauro Carvalho Chehab
4a5e6a76b9 doc-rst: pixfmt-yvyu: remove an empty column
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>
2016-07-03 18:06:42 -03:00
Mauro Carvalho Chehab
8cf590b005 doc-rst: pixfmt-uyvy: remove an empty column
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>
2016-07-03 18:04:21 -03:00
Mauro Carvalho Chehab
6bc87e6651 doc-rst: pixfmt-y12i: correct format conversion
The format conversion broke one paragraph into two. Fix it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 18:00:05 -03:00
Mauro Carvalho Chehab
64e4954619 doc-rst: linux_tv: remove trailing comments
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>
2016-07-03 17:47:40 -03:00
Mauro Carvalho Chehab
5f4c138500 doc-rst: pixfmt-004: Add an extra reference
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>
2016-07-03 17:47:40 -03:00
Mauro Carvalho Chehab
3fc02457be doc-rst: extended-controls: "count" is a constant
Constify the string "count" where it means a field.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 17:47:39 -03:00
Mauro Carvalho Chehab
dd56058747 doc-rst: rw fix a warning
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>
2016-07-03 17:47:39 -03:00
Mauro Carvalho Chehab
a018a1a1a7 doc-rst: open: fix some warnings
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>
2016-07-03 17:47:38 -03:00
Mauro Carvalho Chehab
1021f6bf6d doc-rst: vidioc-g-edid remove a duplicate declaration
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>
2016-07-03 17:47:38 -03:00
Mauro Carvalho Chehab
ef990c2705 doc-rst: fe_property_parameters: improve descriptions
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>
2016-07-03 17:47:37 -03:00
Mauro Carvalho Chehab
08047562ff doc-rst: linux_tv: fix some warnings due to '*'
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>
2016-07-03 17:47:36 -03:00
Mauro Carvalho Chehab
e4aadf72b7 doc-rst: fdl-appendix: Fix formatting issues
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>
2016-07-03 17:47:36 -03:00
Mauro Carvalho Chehab
7f1bd7cdf6 doc-rst: pixfmt-007: Fix formula parsing
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>
2016-07-03 17:47:35 -03:00