diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-13 20:45:57 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-13 20:45:57 -0300 |
commit | f4980c5e8ea66cca3a0966a35b36ba5932e5dca1 (patch) | |
tree | 583b540f02cbfd154d54cd89c5f9a6c817a878dc /staging-specs/media.xml | |
parent | baf2c601d974ae7d46859426c35fdae28a0e7033 (diff) | |
download | mediapointer-dvb-s2-f4980c5e8ea66cca3a0966a35b36ba5932e5dca1.tar.gz mediapointer-dvb-s2-f4980c5e8ea66cca3a0966a35b36ba5932e5dca1.tar.bz2 |
staging-specs: Add a staging tree for Documentation/DocBook
From: Mauro Carvalho Chehab <mchehab@redhat.com>
This patch basically copies V4L and DVB DocBook specs into a single file,
under a temporary staging tree. This is meant to add the set of V4L/DVB API
specifications at Linux Kernel.
For now, it just renames the *sgml files to *xml and creates a common body
for both API's, dividing them into two parts.
Later patches will add some glue for the two specs, move IR to a common part
(since IR keycodes are common to both API's) and add it into
linux/Documentation/DocBook.
Comments and reviews are welcome.
Priority: normal
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'staging-specs/media.xml')
-rw-r--r-- | staging-specs/media.xml | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/staging-specs/media.xml b/staging-specs/media.xml new file mode 100644 index 000000000..28a37f802 --- /dev/null +++ b/staging-specs/media.xml @@ -0,0 +1,154 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "./entities.xml"> %entities; +<!ENTITY indices SYSTEM "./indices.sgml"> + +<!ENTITY eg "e. g."> +<!ENTITY ie "i. e."> +<!ENTITY fd "File descriptor returned by <link linkend='func-open'><function>open()</function></link>."> +<!ENTITY i2c "I<superscript>2</superscript>C"> +<!ENTITY return-value "<title>Return Value</title><para>On success <returnvalue>0</returnvalue> is returned, on error <returnvalue>-1</returnvalue> and the <varname>errno</varname> variable is set appropriately:</para>"> +<!ENTITY manvol "<manvolnum>2</manvolnum>"> + +<!-- Table templates: structs, structs w/union, defines. --> +<!ENTITY cs-str "<colspec colname='c1' colwidth='1*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='2*' /><spanspec spanname='hspan' namest='c1' nameend='c3' />"> +<!ENTITY cs-ustr "<colspec colname='c1' colwidth='1*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='1*' /><colspec colname='c4' colwidth='2*' /><spanspec spanname='hspan' namest='c1' nameend='c4' />"> +<!ENTITY cs-def "<colspec colname='c1' colwidth='3*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='4*' /><spanspec spanname='hspan' namest='c1' nameend='c3' />"> + +<!-- Video for Linux mailing list address. --> +<!ENTITY v4l-ml "<ulink url='http://www.linuxtv.org/lists.php'>http://www.linuxtv.org/lists.php</ulink>"> + +<!-- LinuxTV v4l-dvb repository. --> +<!ENTITY v4l-dvb "<ulink url='http://linuxtv.org/repo/'>http://linuxtv.org/repo/</ulink>"> +]> + +<book id="media_api"> +<bookinfo> +<title>LINUX MEDIA INFRASTRUCTURE API</title> +<subtitle>Version 1.0</subtitle> + +<authorgroup> + <author> + <firstname>Michael</firstname> + <surname>Schimek</surname> + <othername role="mi">H</othername> + <affiliation> + <address> + <email>mschimek@gmx.at</email> + </address> + </affiliation> + </author> + + <author> + <firstname>Bill</firstname> + <surname>Dirks</surname> + <!-- Commented until Bill opts in to be spammed. + <affiliation> + <address> + <email>bill@thedirks.org</email> + </address> + </affiliation> --> + <contrib>Original author of the V4L2 API and + documentation.</contrib> + </author> + + <author> + <firstname>Hans</firstname> + <surname>Verkuil</surname> + <contrib>Designed and documented the VIDIOC_LOG_STATUS ioctl, + the extended control ioctls and major parts of the sliced VBI + API.</contrib> + <affiliation> + <address> + <email>hverkuil@xs4all.nl</email> + </address> + </affiliation> + </author> + + <author> + <firstname>Martin</firstname> + <surname>Rubli</surname> + <!-- + <affiliation> + <address> + <email>martin_rubli@logitech.com</email> + </address> + </affiliation> --> + <contrib>Designed and documented the VIDIOC_ENUM_FRAMESIZES + and VIDIOC_ENUM_FRAMEINTERVALS ioctls.</contrib> + </author> + + <author> + <firstname>Andy</firstname> + <surname>Walls</surname> + <contrib>Documented the fielded V4L2_MPEG_STREAM_VBI_FMT_IVTV + MPEG stream embedded, sliced VBI data format in this specification. + </contrib> + <affiliation> + <address> + <email>awalls@radix.net</email> + </address> + </affiliation> + </author> + + <author> + <firstname>Mauro</firstname> + <surname>Carvalho Chehab</surname> + <contrib>Documented libv4l, designed and added v4l2grab example, + Remote Controller chapter + </contrib> + <affiliation> + <address> + <email>mchehab@redhat.com</email> + </address> + </affiliation> + </author> + <author> + <!-- FIXME: Add the V4L authors --> + <firstname>Ralph</firstname> + <surname>Metzler</surname> + <othername role="mi">J. K.</othername> + <affiliation><address><email>rjkm@metzlerbros.de</email></address></affiliation> + </author> + <author> + <firstname>Marcus</firstname> + <surname>Metzler</surname> + <othername role="mi">O. C.</othername> + <affiliation><address><email>rjkm@metzlerbros.de</email></address></affiliation> + </author> + </authorgroup> + + <copyright> + <year>1999</year> + <year>2000</year> + <year>2001</year> + <year>2002</year> + <year>2003</year> + <year>2004</year> + <year>2005</year> + <year>2006</year> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <holder>Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin + Rubli, Andy Walls, Mauro Carvalho Chehab, Ralph Metzler, Marcus Metzler</holder> + </copyright> + +<legalnotice> + +<para>Permission is granted to copy, distribute and/or modify +this document under the terms of the GNU Free Documentation License, +Version 1.1 or any later version published by the Free Software +Foundation. A copy of the license is included in the chapter entitled +"GNU Free Documentation License"</para> +<para>Programming examples can be used and distributed without + restrictions.</para> +</legalnotice> + +</bookinfo> + +<toc></toc> <!-- autogenerated --> +&sub-v4l2; +&sub-dvbapi; +</book> |