07 Jul, 2016
2 commits
-
This file is auto-generated with DocBook, from the uapi header.
Do the same with Sphinx.
Signed-off-by: Mauro Carvalho Chehab
-
This script parses a header file and converts it into a
parsed-literal block, creating references for ioctls,
defines, typedefs, enums and structs.It also allow an external file to modify the rules, in
order to fix the expressions.Signed-off-by: Mauro Carvalho Chehab
06 Jul, 2016
24 commits
-
There's no need for all caps at its name. As the book title is
now showing at the top of each page, let's use Camel Case, to
make it less bold.Signed-off-by: Mauro Carvalho Chehab
-
The V4L2 is the only part of the doc that has the word "Specification"
and mentions its version on the title.Having the version there was important in the past, while we were
getting rid of V4L version 1. But, as v1 is long gone, all it lasts
is history (with is, btw, covered on the spec). So, no need to keep
the version on its title.So, rename it, to be more generic and look like the remaining
of the document.Signed-off-by: Mauro Carvalho Chehab
-
The Digital TV section is ackward for two reasons:
1) it is the only one with everything in upper case;
2) its name is associated with the European digital TV standard.Rename the part name, and add a notice that it refers to what's
known as "DVB API".Signed-off-by: Mauro Carvalho Chehab
-
Make it look like V4L, DVB and MC docbooks initial page.
Signed-off-by: Mauro Carvalho Chehab
-
Add a :widths: at the flat-table, to make it to look nicer.
Signed-off-by: Mauro Carvalho Chehab
-
Add a :widths: at the flat-table, to improve the visual.
Signed-off-by: Mauro Carvalho Chehab
-
The tables were not properly converted. It looked a little
ackward already at DocBook, but the conversion made it worse.Fix them.
Signed-off-by: Mauro Carvalho Chehab
-
Those cross references should point to media control syscalls,
and not to V4L ones.Signed-off-by: Mauro Carvalho Chehab
-
Remove a 'm' at the end of the last phrase.
Signed-off-by: Mauro Carvalho Chehab
-
Just like V4L and DVB parts, add the copyright symbol.
Signed-off-by: Mauro Carvalho Chehab
-
When I wrote the MC next gen patches, I also improved the media
controller documentation and added documentation for
MEDIA_IOC_G_TOPOLOGY, but I forgot to add the credits on that
time.Signed-off-by: Mauro Carvalho Chehab
-
Make it look just like v4l and DVB parts.
Signed-off-by: Mauro Carvalho Chehab
-
The video, audio and OSD APIs are obsolete. V4L2 should be
used instead. So, remove them from this intro item.Signed-off-by: Mauro Carvalho Chehab
-
The include blocks were not properly displayed. Fix it.
Signed-off-by: Mauro Carvalho Chehab
-
The png image was not base64 decoded correctly.
Fix it.Signed-off-by: Mauro Carvalho Chehab
-
The conversion of this file didn't happen too well. We want
the items numbered, and format it just like what we did with
part 1 of the document.Signed-off-by: Mauro Carvalho Chehab
-
Fixes this warning:
Documentation/linux_tv/media/v4l/dev-overlay.rst:247: WARNING: Title underline too short.
struct v4l2_clip [4]_
----------------Signed-off-by: Mauro Carvalho Chehab
-
Fixes this warning:
Documentation/linux_tv/media/v4l/dmabuf.rst:150: WARNING: undefined label: vidioc_dqbuf (if the link has no caption the label must precede a section header)Signed-off-by: Mauro Carvalho Chehab
-
Now that we have one syscall per page, using :cpp:function::
cleans up almost all warnings, with is a great thing.Signed-off-by: Mauro Carvalho Chehab
-
On the syscall conversions, we used uppercase for the sections,
but this is too bold. So, convert them to Camel Case, as it
looks visually better.Signed-off-by: Mauro Carvalho Chehab
-
The layout of (table) captions in the RTD theme is a bit ugly and the
bordered, red colored of inline literals is a bit to gaudy. The
requirements has been discussed in the ML [1].captions:
- captions should have 100% (not 85%) font size
- hide the permalink symbol as long as link is not hoveredinline literal:
- drop the borderbox and red color
[1] http://article.gmane.org/gmane.linux.drivers.video-input-infrastructure/101099
Signed-off-by: Markus Heiser
-
The default table layout of the RTD theme does not fit for vast tables,
like the ones we have in the linux_tv project. This has been discussed
on the ML [1].The RTD theme is a two column layout, with a navigation column on the
left and a content column on the right:content column
RTD theme's default is 800px as max width for the content, but we have
tables with tons of columns, which need the full width of the
view-port (BTW: *full width* is what DocBook's HTML is).table
- sequences of whitespace should collapse into a single whitespace.
- make the overflow auto (scrollbar if needed)
- align caption "left" ("center" is unsuitable on vast tables)[1] http://article.gmane.org/gmane.linux.kernel/2216509
Signed-off-by: Markus Heiser
-
This file is actually not used to build the media uAPI docbook.
So, remove it.Signed-off-by: Mauro Carvalho Chehab
-
Implements the minimal boilerplate for Sphinx HTML theme customization.
Signed-off-by: Markus Heiser
Signed-off-by: Mauro Carvalho Chehab
05 Jul, 2016
14 commits
-
On some syscall descriptions, the tables are described after
the return value. Do that inside descriptions.Signed-off-by: Mauro Carvalho Chehab
-
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
-
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
-
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
-
Fix some cross-references and improve the layout of this
page.Signed-off-by: Mauro Carvalho Chehab
-
Add a numbering for the figure.
Signed-off-by: Mauro Carvalho Chehab
-
The conversion from DocBook made somethings look ugly.
Improve them.Signed-off-by: Mauro Carvalho Chehab
-
Sphinx doesn't format nice table captions, nor auto-numberate
them. So, convert tables into chapters.Signed-off-by: Mauro Carvalho Chehab
-
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
-
Use cross-references for read()/write() on a few places
where they weren't used.Signed-off-by: Mauro Carvalho Chehab
-
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
-
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
-
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
-
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