- 05 Jul, 2016 10 commits
-
-
Mauro Carvalho Chehab authored
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 <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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 <mchehab@s-opensource.com>
-
Markus Heiser authored
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 hovered inline literal: - drop the borderbox and red color [1] http://article.gmane.org/gmane.linux.drivers.video-input-infrastructure/101099Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
-
Markus Heiser authored
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/2216509Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
-
Mauro Carvalho Chehab authored
This file is actually not used to build the media uAPI docbook. So, remove it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Markus Heiser authored
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 authored
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 authored
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 authored
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 authored
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>
-
- 04 Jul, 2016 30 commits
-
-
Mauro Carvalho Chehab authored
Fix some cross-references and improve the layout of this page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Add a numbering for the figure. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The conversion from DocBook made somethings look ugly. Improve them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
The conversion from DocBook removed them. Re-add. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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 authored
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 authored
The conversion from DocBook removed them. Re-add. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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 authored
The conversion from DocBook removed them. Re-add. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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 authored
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>
-