Markus Heiser [Sun, 3 Jul 2016 08:05:28 +0000 (10:05 +0200)]
doc-rst: boilerplate HTML theme customization
Implements the minimal boilerplate for Sphinx HTML theme customization.
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Tue, 5 Jul 2016 14:36:55 +0000 (11:36 -0300)]
doc-rst: linux_tv: dvb: put return value at the end
On some syscall descriptions, the tables are described after
the return value. Do that inside descriptions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Tue, 5 Jul 2016 14:22:28 +0000 (11:22 -0300)]
doc-rst: linux_tv: dvb: use lowercase for filenames
There are some ioctls in upper case. This is not the standard.
Put them on lowercase, to match what's done with other ioctls.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Tue, 5 Jul 2016 10:58:48 +0000 (07:58 -0300)]
doc-rst: linux_tv: reformat all syscall pages
The syscall pages are written to be used also as man-pages.
However, they don't match the format used by kernel-doc
generated pages from DocBook. Rewrite them to match it.
One side effect is that now all such pages at the book
will have the same format, reducing the format differences
between DVB and the other parts of the book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Tue, 5 Jul 2016 13:37:31 +0000 (10:37 -0300)]
doc-rst: linux_tv: split DVB function call documentation
Just like V4L, split the DVB function calls into one file per
system call. This is a requirement for the man pages creator
on Sphinx to work, and makes the document easier to maintain.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 22:03:49 +0000 (19:03 -0300)]
doc-rst: libv4l-introduction: improve format
Fix some cross-references and improve the layout of this
page.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:53:54 +0000 (18:53 -0300)]
doc-rst: subdev-formats: Improve figure caption
Add a numbering for the figure.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:47:13 +0000 (18:47 -0300)]
doc-rst: dev-subdev: fix some format issues
The conversion from DocBook made somethings look ugly.
Improve them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:37:48 +0000 (18:37 -0300)]
doc-rst: dev-sliced-vbi: convert table captions into headers
Sphinx doesn't format nice table captions, nor auto-numberate
them. So, convert tables into chapters.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:32:02 +0000 (18:32 -0300)]
doc-rst: dev-raw-vbi fix conversion issues
There are several things that didn't convert well. Fix them,
in order to improve the layout of the formatted document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:16:57 +0000 (18:16 -0300)]
doc-rst: linux_tv: Use references for read()/write()
Use cross-references for read()/write() on a few places
where they weren't used.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:05:55 +0000 (18:05 -0300)]
doc-rst: dev-codec: Fix a reference for _STREAMON
The referenced ioctl there is only VIDIOC_STREAMON, so we
should override the name, to avoid it to also show _STREAMOFF.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 21:01:04 +0000 (18:01 -0300)]
doc-rst: dev-osd: Fix some issues due to conversion
The conversion to ReST broke a minor things. Fix them.
While here, also make EBUSY constant, just like on other places.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 20:51:48 +0000 (17:51 -0300)]
doc-rst: dev-overlay: Fix conversion issues
There were several conversion issues on this file, causing it
to be badly formatted. Fix them, in order to match the
design used on DocBook.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 20:14:00 +0000 (17:14 -0300)]
doc-rst: buffer: numerate tables and figures
Sphinx actually doesn't numerate tables nor figures. So,
let's add a subtitle before each table. That makes them
"numerated".
While here, fix the git binary that got corrupted.
Let's hope this will work, as the reason why we had
to encode them were to prevent some issues on commiting
those gif files on git.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 19:50:00 +0000 (16:50 -0300)]
doc-rst: buffer: numerate tables
Sphinx actually doesn't numerate tables. So, let's add a
subtitle before each table. That makes them numerated.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 19:43:03 +0000 (16:43 -0300)]
doc-rst: dmabuf: 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.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 19:31:20 +0000 (16:31 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 19:25:48 +0000 (16:25 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 19:06:57 +0000 (16:06 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 19:01:08 +0000 (16:01 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 18:58:05 +0000 (15:58 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 18:47:55 +0000 (15:47 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 17:22:27 +0000 (14:22 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 16:58:01 +0000 (13:58 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 16:51:02 +0000 (13:51 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 16:44:38 +0000 (13:44 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 16:37:29 +0000 (13:37 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 16:35:10 +0000 (13:35 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 16:30:26 +0000 (13:30 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:56:17 +0000 (12:56 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:46:04 +0000 (12:46 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:42:14 +0000 (12:42 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:39:49 +0000 (12:39 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:37:18 +0000 (12:37 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:34:44 +0000 (12:34 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:31:15 +0000 (12:31 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:28:52 +0000 (12:28 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:24:49 +0000 (12:24 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:22:09 +0000 (12:22 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:15:56 +0000 (12:15 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 15:07:22 +0000 (12:07 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 14:45:59 +0000 (11:45 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 14:29:35 +0000 (11:29 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 13:06:33 +0000 (10:06 -0300)]
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>
Mauro Carvalho Chehab [Mon, 4 Jul 2016 12:04:31 +0000 (09:04 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 22:07:02 +0000 (19:07 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:55:19 +0000 (18:55 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:49:18 +0000 (18:49 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:44:59 +0000 (18:44 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:31:54 +0000 (18:31 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:27:42 +0000 (18:27 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:23:22 +0000 (18:23 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:08:29 +0000 (18:08 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:06:42 +0000 (18:06 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:04:21 +0000 (18:04 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 21:00:05 +0000 (18:00 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 20:27:03 +0000 (17:27 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 20:25:37 +0000 (17:25 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 19:25:30 +0000 (16:25 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 19:07:25 +0000 (16:07 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 19:03:47 +0000 (16:03 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 18:51:23 +0000 (15:51 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 18:32:31 +0000 (15:32 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 17:45:00 +0000 (14:45 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 17:35:43 +0000 (14:35 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 17:25:30 +0000 (14:25 -0300)]
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 16:51:40 +0000 (13:51 -0300)]
doc-rst: linux_tv: Fix remaining undefined references
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 16:28:28 +0000 (13:28 -0300)]
doc-rst: linux_tv: use references for structures
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 14:53:09 +0000 (11:53 -0300)]
doc-rst: linux_tv: Error codes should be const
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 14:33:18 +0000 (11:33 -0300)]
doc-rst: selection-api-006: add missing captions
The example captions got stripped by the conversion to ReST.
Re-add.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 14:24:58 +0000 (11:24 -0300)]
doc-rst: linux_tv: use Example x.y. instead of a single number
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 14:17:12 +0000 (11:17 -0300)]
doc-rst: selection-api-005: Fix ReST parsing
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 14:00:48 +0000 (11:00 -0300)]
doc-rst: crop: fix conversion on this file
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>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 13:28:06 +0000 (10:28 -0300)]
doc-rst: planar-apis: fix some conversion troubles
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>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 12:49:16 +0000 (09:49 -0300)]
doc-rst: linux_tv: supress lots of warnings
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>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 12:17:15 +0000 (09:17 -0300)]
doc-rst: vidioc-queryctl: change the title of this chapter
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>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 12:17:08 +0000 (09:17 -0300)]
doc-rst: extended-controls: use reference for VIDIOC_S_CTRL
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>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 12:15:48 +0000 (09:15 -0300)]
doc-rst: control: Fix missing reference for example 8
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>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 11:43:46 +0000 (08:43 -0300)]
doc-rst: control: read the example captions
Those got removed by the doc conversion.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 11:37:16 +0000 (08:37 -0300)]
doc-rst: linux_tv: remove controls
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>
Mauro Carvalho Chehab [Sat, 2 Jul 2016 11:32:22 +0000 (08:32 -0300)]
doc-rst: standard: read the example captions
Those got lost during format conversion.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 17:49:48 +0000 (14:49 -0300)]
doc-rst: audio: re-add captions for the examples
The captions were lost during the format conversion.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 3 Jul 2016 13:02:29 +0000 (10:02 -0300)]
doc-rst: linux_tv: don't simplify VIDIOC_G_foo references
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 17:33:56 +0000 (14:33 -0300)]
doc-rst: linux_tv: convert lots of consts to references
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 16:58:44 +0000 (13:58 -0300)]
doc-rst: linux_tv: simplify references
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 16:42:29 +0000 (13:42 -0300)]
doc-rst: linux_tv: Replace reference names to match ioctls
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 01:52:34 +0000 (22:52 -0300)]
doc-rst: audio: Fix some cross references
There are several constants there that should be, instead,
cross-references. Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 01:45:08 +0000 (22:45 -0300)]
doc-rst: video: Restore the captions for the examples
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 01:36:58 +0000 (22:36 -0300)]
doc-rst: v4l2: numerate the V4L2 chapters
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 01:17:31 +0000 (22:17 -0300)]
doc-rst: video: use reference for VIDIOC_ENUMINPUT
Instead of using const, transform it into a reference.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 00:58:44 +0000 (21:58 -0300)]
doc-rst: app-pri: Fix a bad reference
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 00:52:52 +0000 (21:52 -0300)]
doc-rst: linux_tv/index: add xrefs for document divisions
Make easier to navigate at the media document by adding the
links to each of the parts of the document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 1 Jul 2016 00:35:28 +0000 (21:35 -0300)]
doc-rst: querycap: fix troubles on some references
This is not due to the format change, but there are some
wrong references on this file. Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 30 Jun 2016 20:53:07 +0000 (17:53 -0300)]
doc-rst: v4l2: Fix authors and revisions lists
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 30 Jun 2016 20:12:20 +0000 (17:12 -0300)]
doc-rst: some fixups at linux_tv/index
Fix some issues from the conversion and improve the documentation
a little bit, by adding two relevent keywords (SDR and DTMB).
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 30 Jun 2016 19:33:35 +0000 (16:33 -0300)]
doc-rst: linuxt_tv: update the documentation year
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Markus Heiser [Thu, 30 Jun 2016 13:18:56 +0000 (15:18 +0200)]
doc-rst: linux_tv DocBook to reST migration (docs-next)
This is the restructuredText (reST) migration of the ``media``
DocBook-XML set from the linux_tv project.
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 30 Jun 2016 19:10:47 +0000 (16:10 -0300)]
Merge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-next
* '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
...
Jonathan Corbet [Thu, 30 Jun 2016 19:07:33 +0000 (13:07 -0600)]
Add .pyc files to .gitignore
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This page took 0.044484 seconds and 5 git commands to generate.