|| ||Mauro Carvalho Chehab <firstname.lastname@example.org> |
|| ||Linux Media Mailing List <email@example.com>,
Randy Dunlap <firstname.lastname@example.org>,
|| ||V4L/DVB API specifications at linux kernel |
|| ||Tue, 15 Sep 2009 16:20:02 -0300|
|| ||Article, Thread
Something that always bothered me is that the documentation inside the kernel
for V4L/DVB were never properly updated, since people that write drivers in
general don't bother to keep the docs updated there. After some time, we've
removed V4L1 API from kernel (in text format, as far as I can remember), but
never added V4L2 API. Also, there weren't there any dvb api specs.
As an effort to change it, I did a work during the last few weeks to port V4L2 API
from DocBook v3.1 to DocBook XML v4.1.2. I also ported DVB specs from LaTex
into DocBook XML v4.1.2. This way, the API docs are compatible with the DocBook version
used in kernel (even eventually not having the same writing style as found there).
I tried to make the port as simple as possible, yet preserving the original
text. So, for sure there are space for style reviews, especially at the dvb
part, where the LaTex -> xml conversion were harder.
After having both ported, I've rearranged a few chapters and merged them
both into just one DocBook book, to allow having some parts shared, like IR.
The final document were broken into 3 parts:
I. Video for Linux Two API Specification
(basically, the same contents found at V4L2 spec version 2.6.32, except for IR chapter)
II. Linux DVB API
(basically, the same contents found at DVB spec version 3)
III. Other API's used by media infrastructure drivers
(basically, the IR chapter taken from V4L2 spec)
The resulting html pages can be seen at: http://linuxtv.org/downloads/v4l_dvb_apis/
The Kernel patches with the Document are at:
Please review. If they're ok, I'm intending to submit them for addition at 2.6.32.
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to email@example.com
More majordomo info at http://vger.kernel.org/majordomo-info.html