| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
There are still a few tables with wrong columns at the uAPI
docs. Fix them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Sphinx is really pedantic with respect to the order where
table tags and references are created. Putting things at
the wrong order causes troubles.
The order that seems to work is:
.. raw:: latex
.. tabularcolumns::
.. _foo_name:
.. cssclass: longtable
.. flat-table::
Reorder the tags to the above order, to avoid troubles, and
fix remaining warnings introduced by media recent patches.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Fix the generic errors table to avoid column overflows on
LaTeX output.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Fix tables to avoid text to overflow the cell limits.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There are some things there that aren't ok for ReST format.
Fix them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
The CEC kAPI documentation should also be part of the media book.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
A few tables at the media uAPI documentation have columns
not well dimentioned. Adjust them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There are a few broken tables on LaTeX output at the DVB
uAPI documentation. Fix them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Add position hints for some tables, in order for them to be
shown properly on LaTeX output.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Adjust the tables there to fit inside the page margins.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Several tables are missing column definitions and/or are too big
to fit into the page. Adjust them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
The tuner type table misses descriptions for each type. While
most of stuff are obvious, the two SDR definitions aren't.
So, add descriptions to all of them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Adjust simple cases where the columns on some vidioc files
are overriding their neighbours.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
The tables don't fit at the page on this file. As noticed
before, Sphinx (or LaTeX?) does a crap job on tables with
cell span, and some work has to be done to make it fit.
Move the see also reference to a footnote, break one paragraph
into two and adjust the table columns to make it visible.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
This table is too big for LaTeX output, and lacks columns
specs for LaTeX format.
Also, it has a hidden column, as there are some cell spans
with the wrong values.
Fix it, so it can be displayed properly on LaTeX/PDF.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Some tables are not properly displayed on LaTeX. Fix them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There are two tables with mangled columns. Fix it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Better adjust the columns for LaTeX output
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
This table has several troubles:
- a duplicated "struct" on its name;
- a reference to a V4L version 1 struct that will never
point to something (as we got rid of V4L1 API a long
time ago);
- misses hints for LaTeX output (column size and longtable
style).
Fix them.
It should be noticed that the first column of this table is
not aligned with the rest. I suspect that this is a bug at
the flat-table extension.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Fix mosto fo the tables there in order to make them fit at the
page size.
There are, however, two exceptions: RGB and YUV big tables,
where adding the raw latex adjustbox caused the tables to not
be properly formatted. I suspect that the problem is because
those are long tables, but not really sure.
The thing is that Sphinx lacks an "adjustbox" tag that would
avoid the raw latex hacks.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
The table there is too big and doesn't have format hints for
LaTeX output.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
One of the tables has wrong column dimentions. Fix it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Better format the tables in a way that will fit inside the
page.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Just like on dvb-raw-vbi.rst, the LaTeX output doesn't work
well with cell spans. Also, this is actually a note, so, move
it to a footnote.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Originally, each image were one page big, causing them to be
displayed on separate pages at the PDF output. Re-generate
them from the gif files.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Add the needed tags to fix LaTeX output of the tables there.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There's a bug with LaTeX output on flat-tables with Sphinx 1.4.5
that prevents references at a cell span to be broken. As the
text is indeed too long, it makes sense to place the reference
to the pictures showing the VBI limits as a footnote.
That makes the text easier to read and also solves the issue
with LaTeX output.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There's one note there that it is indented for no good reason.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
The table columns are not properly displayed. Also, some
tables are too big to fit into just one page. So, fix them,
in order to better display the tables.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Those hints are wrong, and doesn't really improve the look
of those tables. So, keep them only when they're useful.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Adjust the table to fit at the LaTeX and PDF outputs, just like
what was done with pixfmt-packed-rgb.rst.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Adjust the tables to fit at the LaTeX and PDF outputs.
I wrote a previous patch RFC to show the big table in landscape,
but it makes harder to read on displays.
So, instead, let's use the adjustbox to shrink the size of those
long tables, as the table size can still be visible on screen,
and it is a way better to read in horizontal position and
visible if printed.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There is an extra column just before eack pack of bits, to
improve table reading, but the header file didn't take this
into account.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Add column hints for LaTeX to format columns on the tables inside
pixfmt-002.rst and pixfmt-006.rst.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Lots of tables at extended-controls.rst need explicit hints for
LaTeX to adjust their widths. Provide that.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Manually adjust the table width for it to look nice on PDF output.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.
As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:
my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
if (!$table_header) {
$has_cols = 1 if (m/..\s+tabularcolumns::/);
if (m/..\s+flat-table::/) {
$table_header = 1;
$header = $_;
next;
}
$out .= $_;
next;
}
$header .= $_;
@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
if (m/^\n$/) {
if (!$has_cols && @widths) {
my ($tot, $t, $i) = (0, 0, 0);
foreach my $v(@widths) { $tot += $v; };
$out .= ".. tabularcolumns:: |";
for ($i = 0; $i < scalar @widths - 1; $i++) {
my $v = $widths[$i];
my $w = round(10 * ($v * $line_size) / $tot) / 10;
$out .= sprintf "p{%.1fcm}|", $w;
$t += $w;
}
my $w = $line_size - $t;
$out .= sprintf "p{%.1fcm}|\n\n", $w;
}
$out .= $header;
$table_header = 0;
$has_cols = 0;
$header = "";
@widths = ();
}
}
print $out;
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There are some texts there on the wrong place. Re-generate it
from the svg file.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Both tables on this rst file were not shown right, as they miss
the proper tag (tabularcolumns) to specify the column widths
required for PDF and LaTeX output.
Also, the second table is too big to fit into one page. So,
it should use the longtable class to allow it to be split into
two pages.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
There are two tables with a C code-block inside it. Unfortunately,
that causes LaTeX output to break. Yet, there's nothing special
there, so let's remove the code-block from them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Change multi-line note tags to be more symetric, e. g. not starting
the text together witht the tag.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
The items at the sound carrier had a bullet. Those are not needed.
So, get rid of them.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
Somehow, the conversion broke a reference here. Re-add it.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
pdflatex doesn't like gif images:
None:None: WARNING: no matching candidate for image URI u'media/uapi/v4l/pixfmt-nv12mt_files/nv12mt.*'
None:None: WARNING: no matching candidate for image URI u'media/uapi/v4l/pixfmt-nv12mt_files/nv12mt_example.*'
But it works fine with png. So, convert them. As a plus, PNG images
are smaller.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
|
|
|
|
Coalesce development-tool documents into a single directory and sphinxify
them.
|
|
Acked-by: Jan Kiszka <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
|
|
Cc: Vegard Nossum <[email protected]>
Cc: Pekka Enberg <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
|
|
Acked-by: Catalin Marinas <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
|
|
Acked-by: Andrey Ryabinin <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
|