summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* doc-rst: parse-headers: fix multiline typedef handlerMauro Carvalho Chehab2016-07-071-3/+4
| | | | | | | | | | | | | The typedef handler should do two things to be generic: 1) parse typedef enums; 2) accept both possible syntaxes: typedef struct foo { .. } foo_t; typedef struct { .. } foo_t; Unfortunately, this is needed to parse some legacy DVB files, like dvb/audio.h. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: parse-headers: better handle typedefsMauro Carvalho Chehab2016-07-071-2/+7
| | | | | | | When typedef is used on its multiline format, we need to also parse enum and struct in the same line. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: parse-headers: be more formal about the valid symbolsMauro Carvalho Chehab2016-07-071-8/+8
| | | | | | | Be more formal about the valid symbols that are expected by the parser, to match what c language expects. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: fix parsing comments and '{' on a separate lineMauro Carvalho Chehab2016-07-071-6/+11
| | | | | | | | | | | | | The dmx.h header has two things that causes the parser to break while handling enums: per-header enums and the '{' starts on a new line Both makes the parser to get lexical marks to be detected as if they were symbols. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-dst: parse-headers: highlight deprecated commentsMauro Carvalho Chehab2016-07-071-0/+2
| | | | | | | When something is deprecated, highlight it, as we want it to be clearer to the reader. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: parse-headers: improve delimiters to detect symbolsMauro Carvalho Chehab2016-07-071-13/+14
| | | | | | | | | As we had to escape the symbols for the ReST markup to not do the wrong thing, the logic to discover start/end of strings are not trivial. Improve the end delimiter detection, in order to highlight more occurrences of the strings. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: auto-build the frontend.h.rstMauro Carvalho Chehab2016-07-074-609/+60
| | | | | | | | This file is auto-generated with DocBook, from the uapi header. Do the same with Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: add parse-headers.pl scriptMauro Carvalho Chehab2016-07-071-0/+290
| | | | | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: linux_tv/index: Rename the book nameMauro Carvalho Chehab2016-07-061-1/+1
| | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: v4l2: Rename the V4L2 API titleMauro Carvalho Chehab2016-07-061-3/+5
| | | | | | | | | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: Rename the title of the Digital TV sectionMauro Carvalho Chehab2016-07-061-3/+6
| | | | | | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: remote_controllers: fix conversion issuesMauro Carvalho Chehab2016-07-061-4/+12
| | | | | | Make it look like V4L, DVB and MC docbooks initial page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: gen-errors: Improve table layoutMauro Carvalho Chehab2016-07-061-0/+1
| | | | | | Add a :widths: at the flat-table, to make it to look nicer. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: media-ioc-enum-entities: better format the tableMauro Carvalho Chehab2016-07-061-0/+1
| | | | | | Add a :widths: at the flat-table, to improve the visual. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: media-ioc-g-topology: Fix tablesMauro Carvalho Chehab2016-07-061-57/+6
| | | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: mediactl: fix some wrong cross referencesMauro Carvalho Chehab2016-07-053-4/+4
| | | | | | | Those cross references should point to media control syscalls, and not to V4L ones. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: media-controller-model: fix a typoMauro Carvalho Chehab2016-07-051-1/+1
| | | | | | Remove a 'm' at the end of the last phrase. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: media-controller.rst: add missing copy symbolMauro Carvalho Chehab2016-07-051-2/+5
| | | | | | Just like V4L and DVB parts, add the copyright symbol. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: media-controller: missing creditsMauro Carvalho Chehab2016-07-051-0/+7
| | | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: media-controller: fix conversion issuesMauro Carvalho Chehab2016-07-051-3/+9
| | | | | | Make it look just like v4l and DVB parts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: intro: remove obsolete headersMauro Carvalho Chehab2016-07-051-5/+0
| | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: dvb/intro: Better show the needed include blocksMauro Carvalho Chehab2016-07-051-18/+0
| | | | | | The include blocks were not properly displayed. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: fix intro_files/dvbstb.png imageMauro Carvalho Chehab2016-07-051-0/+0
| | | | | | | The png image was not base64 decoded correctly. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: dvbapi: Fix conversion issuesMauro Carvalho Chehab2016-07-051-9/+16
| | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: dev-overlay: fix the last warningMauro Carvalho Chehab2016-07-051-1/+1
| | | | | | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: dmabuf: Fix the cross-referenceMauro Carvalho Chehab2016-07-051-1/+1
| | | | | | | 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 <mchehab@s-opensource.com>
* doc-rst: linux_tv: use :cpp:function:: on all syscallsMauro Carvalho Chehab2016-07-0584-93/+95
| | | | | | | 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>
* doc-rst: linux_tv: don't use uppercases for syscall sectionsMauro Carvalho Chehab2016-07-05182-913/+1107
| | | | | | | | 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>
* doc-rst: customize RTD theme, captions & inline literalMarkus Heiser2016-07-051-0/+25
| | | | | | | | | | | | | | | | | | | 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/101099 Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
* doc-rst: customize RTD theme, table & full widthMarkus Heiser2016-07-051-1/+20
| | | | | | | | | | | | | | | | | | | | | | | | | 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 <markus.heiser@darmarIT.de>
* doc-rst: remove Documentation/linux_tv/conf.py fileMauro Carvalho Chehab2016-07-051-221/+0
| | | | | | | 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>
* doc-rst: boilerplate HTML theme customizationMarkus Heiser2016-07-052-1/+17
| | | | | | | 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>
* doc-rst: linux_tv: dvb: put return value at the endMauro Carvalho Chehab2016-07-0511-58/+41
| | | | | | | 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>
* doc-rst: linux_tv: dvb: use lowercase for filenamesMauro Carvalho Chehab2016-07-059-8/+8
| | | | | | | 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>
* doc-rst: linux_tv: reformat all syscall pagesMauro Carvalho Chehab2016-07-05181-1904/+2261
| | | | | | | | | | | | | 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>
* doc-rst: linux_tv: split DVB function call documentationMauro Carvalho Chehab2016-07-0589-5141/+5399
| | | | | | | | 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>
* doc-rst: libv4l-introduction: improve formatMauro Carvalho Chehab2016-07-051-6/+6
| | | | | | | Fix some cross-references and improve the layout of this page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: subdev-formats: Improve figure captionMauro Carvalho Chehab2016-07-041-3/+1
| | | | | | Add a numbering for the figure. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: dev-subdev: fix some format issuesMauro Carvalho Chehab2016-07-041-8/+8
| | | | | | | The conversion from DocBook made somethings look ugly. Improve them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: dev-sliced-vbi: convert table captions into headersMauro Carvalho Chehab2016-07-041-9/+36
| | | | | | | 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>
* doc-rst: dev-raw-vbi fix conversion issuesMauro Carvalho Chehab2016-07-041-19/+10
| | | | | | | 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>
* doc-rst: linux_tv: Use references for read()/write()Mauro Carvalho Chehab2016-07-044-11/+12
| | | | | | | 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>
* doc-rst: dev-codec: Fix a reference for _STREAMONMauro Carvalho Chehab2016-07-041-1/+1
| | | | | | | 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>
* doc-rst: dev-osd: Fix some issues due to conversionMauro Carvalho Chehab2016-07-041-2/+3
| | | | | | | | 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>
* doc-rst: dev-overlay: Fix conversion issuesMauro Carvalho Chehab2016-07-041-24/+21
| | | | | | | | 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>
* doc-rst: buffer: numerate tables and figuresMauro Carvalho Chehab2016-07-042-4/+10
| | | | | | | | | | | | | 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>
* doc-rst: buffer: numerate tablesMauro Carvalho Chehab2016-07-041-7/+31
| | | | | | | 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>
* doc-rst: dmabuf: Add ioctl cross referencesMauro Carvalho Chehab2016-07-041-19/+22
| | | | | | | | | 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>
* doc-rst: dmabuf: re-add the missing captionsMauro Carvalho Chehab2016-07-041-0/+3
| | | | | | The conversion from DocBook removed them. Re-add. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc-rst: linux_tv: remove whitespacesMauro Carvalho Chehab2016-07-04141-6241/+6241
| | | | | | | | | 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>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-24 17:59:58 +0100