| Age | Commit message (Collapse) | Author |
|---|
|
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>
|
|
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>
|
|
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>
|
|
The conversion from DocBook removed them. Re-add.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
|
|
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>
|
|
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>
|
|
The conversion from DocBook removed them. Re-add.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
|
|
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>
|
|
The conversion from DocBook removed them. Re-add.
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
