summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media_api.tmpl
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-07-05 15:07:37 +0200
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 22:53:35 +0200
commit6d1724925d4da49b84161f1440912205576b7935 (patch)
treee5adf312529fd2edf89ed7f992946eaf9213eefa /Documentation/DocBook/media_api.tmpl
parent[media] marvell-cam: use S/G DMA by default (diff)
downloadlinux-6d1724925d4da49b84161f1440912205576b7935.tar.xz
linux-6d1724925d4da49b84161f1440912205576b7935.zip
[media] DocBook: Add a chapter to describe media errors
There are several errors reported by V4L that aren't described. They can occur on almost all ioctl's. Instead of adding them into each ioctl, create a new chapter. For V4L, the new chapter will automatically be listed on all places, as there's a macro used everywhere there. Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook/media_api.tmpl')
-rw-r--r--Documentation/DocBook/media_api.tmpl7
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/DocBook/media_api.tmpl b/Documentation/DocBook/media_api.tmpl
index 88f2cc680cc2..c273e3c54fc5 100644
--- a/Documentation/DocBook/media_api.tmpl
+++ b/Documentation/DocBook/media_api.tmpl
@@ -8,7 +8,7 @@
<!ENTITY ie "i.&nbsp;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 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. The generic error codes are described at the <link linkend='gen-errors'>Generic Error Codes</link> chapter.</para>">
<!ENTITY manvol "<manvolnum>2</manvolnum>">
<!-- Table templates: structs, structs w/union, defines. -->
@@ -110,6 +110,11 @@ Foundation. A copy of the license is included in the chapter entitled
&sub-media-controller;
</part>
+<chapter id="gen_errors">
+&sub-gen-errors;
+</chapter>
+
+
&sub-fdl-appendix;
</book>