diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-08-31 21:28:58 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-08-31 21:28:58 -0300 |
commit | b13aae56fe48c89e3b1dbefaf165cbab0102216b (patch) | |
tree | 1fa560699f394247610a9a8ebc0cc4b9d5ce45df /v4l2-spec/dev-sliced-vbi.sgml | |
parent | 939633eb8afe2f03adab25337d2f57f0b8ed642d (diff) | |
download | mediapointer-dvb-s2-b13aae56fe48c89e3b1dbefaf165cbab0102216b.tar.gz mediapointer-dvb-s2-b13aae56fe48c89e3b1dbefaf165cbab0102216b.tar.bz2 |
v4l2-spec: convert it to use DocBook XML 4.1.2
From: Mauro Carvalho Chehab <mchehab@redhat.com>
DocBook XML 4.1.2 is the docbook dialect spoken at Linux kernel. By
using it, we can now consider adding V4L2 API docs at the kernel tree.
As a bonus, added support for xmlto, with seems to be better supported
nowadays.
Another additional bounus is that two new Makefile targets were added:
make man - Create V4L2 API man pages
make man_install - Install V4L2 API man pages
By allowing the addition of V4L2 manpages, it is now easier for
developer to quickly check about a V4L2 API or libv4l2 call syntax and
expected return values.
Priority: normal
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'v4l2-spec/dev-sliced-vbi.sgml')
-rw-r--r-- | v4l2-spec/dev-sliced-vbi.sgml | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/v4l2-spec/dev-sliced-vbi.sgml b/v4l2-spec/dev-sliced-vbi.sgml index 3c260e3e3..a2cfc45ef 100644 --- a/v4l2-spec/dev-sliced-vbi.sgml +++ b/v4l2-spec/dev-sliced-vbi.sgml @@ -96,12 +96,12 @@ points which may return <errorcode>EBUSY</errorcode> can be the <title>struct <structname>v4l2_sliced_vbi_format</structname></title> <tgroup cols="5"> - <colspec colname="c1" colwidth="3*"> - <colspec colname="c2" colwidth="3*"> - <colspec colname="c3" colwidth="2*"> - <colspec colname="c4" colwidth="2*"> - <colspec colname="c5" colwidth="2*"> - <spanspec namest="c3" nameend="c5" spanname="hspan"> + <colspec colname="c1" colwidth="3*" /> + <colspec colname="c2" colwidth="3*" /> + <colspec colname="c3" colwidth="2*" /> + <colspec colname="c4" colwidth="2*" /> + <colspec colname="c5" colwidth="2*" /> + <spanspec namest="c3" nameend="c5" spanname="hspan" /> <tbody valign="top"> <row> <entry>__u32</entry> @@ -139,9 +139,9 @@ return the requested set, a subset, which may be just a single service, or an empty set. When the hardware cannot handle multiple services on the same line the driver shall choose one. No assumptions can be made on which service the driver chooses.</para><para>Data -services are defined in <xref linkend="vbi-services2">. Array indices -map to ITU-R line numbers (see also <xref linkend="vbi-525"> and <xref - linkend="vbi-625">) as follows: <!-- No nested +services are defined in <xref linkend="vbi-services2" />. Array indices +map to ITU-R line numbers (see also <xref linkend="vbi-525" /> and <xref + linkend="vbi-625" />) as follows: <!-- No nested tables, sigh. --></para></entry> </row> <row> @@ -211,12 +211,12 @@ extensions. Applications and drivers must set it to zero.</entry> <table frame="none" pgwide="1" id="vbi-services2"> <title>Sliced VBI services</title> <tgroup cols="5"> - <colspec colname="c1" colwidth="2*"> - <colspec colname="c2" colwidth="1*"> - <colspec colname="c3" colwidth="1*"> - <colspec colname="c4" colwidth="2*"> - <colspec colname="c5" colwidth="2*"> - <spanspec namest="c3" nameend="c5" spanname="rlp"> + <colspec colname="c1" colwidth="2*" /> + <colspec colname="c2" colwidth="1*" /> + <colspec colname="c3" colwidth="1*" /> + <colspec colname="c4" colwidth="2*" /> + <colspec colname="c5" colwidth="2*" /> + <spanspec namest="c3" nameend="c5" spanname="rlp" /> <thead> <row> <entry>Symbol</entry> @@ -231,7 +231,7 @@ extensions. Applications and drivers must set it to zero.</entry> <entry><constant>V4L2_SLICED_TELETEXT_B</constant> (Teletext System B)</entry> <entry>0x0001</entry> - <entry><xref linkend="ets300706">, <xref linkend="itu653"></entry> + <entry><xref linkend="ets300706" />, <xref linkend="itu653" /></entry> <entry>PAL/SECAM line 7-22, 320-335 (second field 7-22)</entry> <entry>Last 42 of the 45 byte Teletext packet, that is without clock run-in and framing code, lsb first transmitted.</entry> @@ -239,7 +239,7 @@ without clock run-in and framing code, lsb first transmitted.</entry> <row> <entry><constant>V4L2_SLICED_VPS</constant></entry> <entry>0x0400</entry> - <entry><xref linkend="ets300231"></entry> + <entry><xref linkend="ets300231" /></entry> <entry>PAL line 16</entry> <entry>Byte number 3 to 15 according to Figure 9 of ETS 300 231, lsb first transmitted.</entry> @@ -247,7 +247,7 @@ ETS 300 231, lsb first transmitted.</entry> <row> <entry><constant>V4L2_SLICED_CAPTION_525</constant></entry> <entry>0x1000</entry> - <entry><xref linkend="eia608"></entry> + <entry><xref linkend="eia608" /></entry> <entry>NTSC line 21, 284 (second field 21)</entry> <entry>Two bytes in transmission order, including parity bit, lsb first transmitted.</entry> @@ -255,7 +255,7 @@ bit, lsb first transmitted.</entry> <row> <entry><constant>V4L2_SLICED_WSS_625</constant></entry> <entry>0x4000</entry> - <entry><xref linkend="itu1119">, <xref linkend="en300294"></entry> + <entry><xref linkend="itu1119" />, <xref linkend="en300294" /></entry> <entry>PAL/SECAM line 23</entry> <entry><screen> Byte 0 1 @@ -311,7 +311,7 @@ zero.</para> <row> <entry>__u32</entry> <entry><structfield>id</structfield></entry> - <entry>A flag from <xref linkend="vbi-services"> + <entry>A flag from <xref linkend="vbi-services" /> identifying the type of data in this packet. Only a single bit must be set. When the <structfield>id</structfield> of a captured packet is zero, the packet is empty and the contents of other fields are @@ -334,7 +334,7 @@ field, <constant>1</constant> for the second field.</entry> <entry><structfield>line</structfield></entry> <entry>The field (as opposed to frame) line number this data has been captured from, or shall be inserted at. See <xref - linkend="vbi-525"> and <xref linkend="vbi-625"> for valid + linkend="vbi-525" /> and <xref linkend="vbi-625" /> for valid values. Sliced VBI capture devices can set the line number of all packets to <constant>0</constant> if the hardware cannot reliably identify scan lines. The field number must always be valid.</entry> @@ -349,7 +349,7 @@ Applications and drivers must set it to zero.</entry> <entry>__u8</entry> <entry><structfield>data</structfield>[48]</entry> <entry>The packet payload. See <xref - linkend="vbi-services"> for the contents and number of + linkend="vbi-services" /> for the contents and number of bytes passed for each data type. The contents of padding bytes at the end of this array are undefined, drivers and applications shall ignore them.</entry> @@ -488,7 +488,7 @@ boundary. The payload shall never exceed 1552 bytes (2 fields with <entry><structfield>magic</structfield>[4]</entry> <entry></entry> <entry>A "magic" constant from <xref - linkend="v4l2-mpeg-vbi-fmt-ivtv-magic"> that indicates + linkend="v4l2-mpeg-vbi-fmt-ivtv-magic" /> that indicates this is a valid sliced VBI data payload and also indicates which member of the anonymous union, <structfield>itv0</structfield> or <structfield>ITV0</structfield>, to use for the payload data.</entry> @@ -636,7 +636,7 @@ through 23 of the second field.</entry> <entry>__u8</entry> <entry><structfield>id</structfield></entry> <entry>A line identifier value from -<xref linkend="ITV0-Line-Identifier-Constants"> that indicates +<xref linkend="ITV0-Line-Identifier-Constants" /> that indicates the type of sliced VBI data stored on this line.</entry> </row> <row> |