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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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 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>
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>
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>
Mauro Carvalho Chehab