aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2013-01-11 06:18:55 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2013-02-06 04:34:53 -0500
commit07b64b837d90cf20fad6b4965aa1fecdb4a88e9b (patch)
treeaa63547b7fe121867652ae2c9d842edf5d2b681d /Documentation/DocBook
parentcf1364b17e94624161775b0e681dd967ef366980 (diff)
[media] DocBook: fix various validation errors
Fixed the following errors (with exception of the SVG errors): GEN /home/hans/work/src/v4l/media-git/Documentation/DocBook//v4l2.xml rm -rf Documentation/DocBook/index.html; echo '<h1>Linux Kernel HTML Documentation</h1>' >> Documentation/DocBook/index.html && echo '<h2>Kernel Version: 3.8.0-rc1</h2>' >> Documentation/DocBook/index.html && cat Documentation/DocBook/media_api.html >> Documentation/DocBook/index.html /tmp/x.xml:883: element revremark: validity error : Element structname is not declared in revremark list of possible children /tmp/x.xml:883: element revremark: validity error : Element xref is not declared in revremark list of possible children /tmp/x.xml:9580: element xref: validity error : Element xref was declared EMPTY this one has content /tmp/x.xml:13508: element link: validity error : Element link does not carry attribute linkend /tmp/x.xml:13508: element link: validity error : No declaration for attribute linked of element link /tmp/x.xml:16986: element imagedata: validity error : Value "SVG" for attribute format of imagedata is not among the enumerated set /tmp/x.xml:17003: element imagedata: validity error : Value "SVG" for attribute format of imagedata is not among the enumerated set /tmp/x.xml:17022: element imagedata: validity error : Value "SVG" for attribute format of imagedata is not among the enumerated set Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/common.xml2
-rw-r--r--Documentation/DocBook/media/v4l/io.xml4
-rw-r--r--Documentation/DocBook/media/v4l/pixfmt-srggb10alaw8.xml2
-rw-r--r--Documentation/DocBook/media/v4l/v4l2.xml4
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-expbuf.xml28
5 files changed, 17 insertions, 23 deletions
diff --git a/Documentation/DocBook/media/v4l/common.xml b/Documentation/DocBook/media/v4l/common.xml
index 73c6847436c9..ae06afbbb3a9 100644
--- a/Documentation/DocBook/media/v4l/common.xml
+++ b/Documentation/DocBook/media/v4l/common.xml
@@ -609,7 +609,7 @@ to zero and the <constant>VIDIOC_G_STD</constant>,
609 <para>Applications can make use of the <xref linkend="input-capabilities" /> and 609 <para>Applications can make use of the <xref linkend="input-capabilities" /> and
610<xref linkend="output-capabilities"/> flags to determine whether the video standard ioctls 610<xref linkend="output-capabilities"/> flags to determine whether the video standard ioctls
611are available for the device.</para> 611are available for the device.</para>
612&ENOTTY;. 612
613 <para>See <xref linkend="buffer" /> for a rationale. Probably 613 <para>See <xref linkend="buffer" /> for a rationale. Probably
614even USB cameras follow some well known video standard. It might have 614even USB cameras follow some well known video standard. It might have
615been better to explicitly indicate elsewhere if a device cannot live 615been better to explicitly indicate elsewhere if a device cannot live
diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml
index 2c4646d504c2..e6c58559ca6b 100644
--- a/Documentation/DocBook/media/v4l/io.xml
+++ b/Documentation/DocBook/media/v4l/io.xml
@@ -477,7 +477,7 @@ rest should be evident.</para>
477 477
478 <note> 478 <note>
479 <title>Experimental</title> 479 <title>Experimental</title>
480 <para>This is an <link linkend="experimental"> experimental </link> 480 <para>This is an <link linkend="experimental">experimental</link>
481 interface and may change in the future.</para> 481 interface and may change in the future.</para>
482 </note> 482 </note>
483 483
@@ -488,7 +488,7 @@ DMA buffer from userspace using a file descriptor previously exported for a
488different or the same device (known as the importer role), or both. This 488different or the same device (known as the importer role), or both. This
489section describes the DMABUF importer role API in V4L2.</para> 489section describes the DMABUF importer role API in V4L2.</para>
490 490
491 <para>Refer to <link linked="vidioc-expbuf"> DMABUF exporting </link> for 491 <para>Refer to <link linkend="vidioc-expbuf">DMABUF exporting</link> for
492details about exporting V4L2 buffers as DMABUF file descriptors.</para> 492details about exporting V4L2 buffers as DMABUF file descriptors.</para>
493 493
494<para>Input and output devices support the streaming I/O method when the 494<para>Input and output devices support the streaming I/O method when the
diff --git a/Documentation/DocBook/media/v4l/pixfmt-srggb10alaw8.xml b/Documentation/DocBook/media/v4l/pixfmt-srggb10alaw8.xml
index c934192e98ce..29acc2098cc2 100644
--- a/Documentation/DocBook/media/v4l/pixfmt-srggb10alaw8.xml
+++ b/Documentation/DocBook/media/v4l/pixfmt-srggb10alaw8.xml
@@ -29,6 +29,6 @@
29 formats with 10 bits per color compressed to 8 bits each, 29 formats with 10 bits per color compressed to 8 bits each,
30 using the A-LAW algorithm. Each color component consumes 8 30 using the A-LAW algorithm. Each color component consumes 8
31 bits of memory. In other respects this format is similar to 31 bits of memory. In other respects this format is similar to
32 <xref linkend="V4L2-PIX-FMT-SRGGB8">.</xref></para> 32 <xref linkend="V4L2-PIX-FMT-SRGGB8"></xref>.</para>
33 </refsect1> 33 </refsect1>
34 </refentry> 34 </refentry>
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml
index c3851a2fb50d..a3cce18384e9 100644
--- a/Documentation/DocBook/media/v4l/v4l2.xml
+++ b/Documentation/DocBook/media/v4l/v4l2.xml
@@ -143,9 +143,7 @@ applications. -->
143 <revnumber>3.9</revnumber> 143 <revnumber>3.9</revnumber>
144 <date>2012-12-03</date> 144 <date>2012-12-03</date>
145 <authorinitials>sa, sn</authorinitials> 145 <authorinitials>sa, sn</authorinitials>
146 <revremark>Added timestamp types to 146 <revremark>Added timestamp types to v4l2_buffer.
147 <structname>v4l2_buffer</structname>, see <xref
148 linkend="buffer-flags" />.
149 Added <constant>V4L2_EVENT_CTRL_CH_RANGE</constant> control 147 Added <constant>V4L2_EVENT_CTRL_CH_RANGE</constant> control
150 event changes flag, see <xref linkend="changes-flags"/>. 148 event changes flag, see <xref linkend="changes-flags"/>.
151 </revremark> 149 </revremark>
diff --git a/Documentation/DocBook/media/v4l/vidioc-expbuf.xml b/Documentation/DocBook/media/v4l/vidioc-expbuf.xml
index 72dfbd20a802..e287c8fc803b 100644
--- a/Documentation/DocBook/media/v4l/vidioc-expbuf.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-expbuf.xml
@@ -83,15 +83,14 @@ descriptor. The application may pass it to other DMABUF-aware devices. Refer to
83<link linkend="dmabuf">DMABUF importing</link> for details about importing 83<link linkend="dmabuf">DMABUF importing</link> for details about importing
84DMABUF files into V4L2 nodes. It is recommended to close a DMABUF file when it 84DMABUF files into V4L2 nodes. It is recommended to close a DMABUF file when it
85is no longer used to allow the associated memory to be reclaimed. </para> 85is no longer used to allow the associated memory to be reclaimed. </para>
86
87 </refsect1> 86 </refsect1>
87
88 <refsect1> 88 <refsect1>
89 <section> 89 <title>Examples</title>
90 <title>Examples</title>
91 90
92 <example> 91 <example>
93 <title>Exporting a buffer.</title> 92 <title>Exporting a buffer.</title>
94 <programlisting> 93 <programlisting>
95int buffer_export(int v4lfd, &v4l2-buf-type; bt, int index, int *dmafd) 94int buffer_export(int v4lfd, &v4l2-buf-type; bt, int index, int *dmafd)
96{ 95{
97 &v4l2-exportbuffer; expbuf; 96 &v4l2-exportbuffer; expbuf;
@@ -108,12 +107,12 @@ int buffer_export(int v4lfd, &v4l2-buf-type; bt, int index, int *dmafd)
108 107
109 return 0; 108 return 0;
110} 109}
111 </programlisting> 110 </programlisting>
112 </example> 111 </example>
113 112
114 <example> 113 <example>
115 <title>Exporting a buffer using the multi-planar API.</title> 114 <title>Exporting a buffer using the multi-planar API.</title>
116 <programlisting> 115 <programlisting>
117int buffer_export_mp(int v4lfd, &v4l2-buf-type; bt, int index, 116int buffer_export_mp(int v4lfd, &v4l2-buf-type; bt, int index,
118 int dmafd[], int n_planes) 117 int dmafd[], int n_planes)
119{ 118{
@@ -137,12 +136,9 @@ int buffer_export_mp(int v4lfd, &v4l2-buf-type; bt, int index,
137 136
138 return 0; 137 return 0;
139} 138}
140 </programlisting> 139 </programlisting>
141 </example> 140 </example>
142 </section>
143 </refsect1>
144 141
145 <refsect1>
146 <table pgwide="1" frame="none" id="v4l2-exportbuffer"> 142 <table pgwide="1" frame="none" id="v4l2-exportbuffer">
147 <title>struct <structname>v4l2_exportbuffer</structname></title> 143 <title>struct <structname>v4l2_exportbuffer</structname></title>
148 <tgroup cols="3"> 144 <tgroup cols="3">