I've sent a patch earlier today with the DocBook conversion of the DVB API
specs.
However, it seems that the size is just too big for it to be accepted
by vger.
So, instead of a patch, I'm creating a dvb-specs temporary tree with the 4
conversion patches from LaTex do DocBook:
http://linuxtv.org/hg/~mchehab/dvb-specs
The description of the resulting changeset is given bellow.
Please review.
Have fun!
Mauro
---
Converts DVB Version 3 API specification to DocBook XML 4.1.2 format
As kernel documentation and V4L2 API docs are using DocBook XML 4.1.2,
convert also the DVB spec into DocBook.
There are some advantages of using DocBook format over LaTex:
1) The Makefile can generate not only pdf, but also single and a multiple files
html, being easier to integrate it on websites;
2) In the future, it can be used to also generate man pages;
3) It is possible to share parts of the book with kernel and between V4L2 and
DVB API's;
4) Developers now can use just one language for working with DVB API, V4L2 API
and other kernel documents;
5) With the docbook version, just one set of documentation application sets is
needed
to generate both DVB and V4L2 API's;
6) By using some easy scripts (like what is present at v4l2-spec/Makefile), it
will be possible to include some example files from the development tree
directly from a c file;
7) It will be possible to add some scripts to validate if API changes done at
the
DVB core code weren't integrated at the API spec (like what's already done with
V4L2
controls and formats).
For now, this patchset doesn't remove the LaTex docs, nor brings any
improvement at the spec or at its format. It
It is just a conversion done by using
htlatex, several perl parsing scripts and some manual work to fix some
conflicts and to
make DocBook compile. There are spaces for more improvements to be done.
Comments?
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Cheers,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
