[PATCH RFCv3 05/17] [media] DocBook: Remove V4L generic error description for ioctl()

Mauro Carvalho Chehab
2011-07-06T18:05:40Z

V4L ioctl function descripton also has a generic error chapter.
Remove it, as it is now obsoleted by a general, multi-API generic
error descriptions.

Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

diff --git a/Documentation/DocBook/media/v4l/func-ioctl.xml b/Documentation/DocBook/media/v4l/func-ioctl.xml
index b60fd37..2de64be 100644
--- a/Documentation/DocBook/media/v4l/func-ioctl.xml
+++ b/Documentation/DocBook/media/v4l/func-ioctl.xml
@@ -64,75 +64,9 @@ their respective function and parameters are specified in <xref
</refsect1>

<refsect1>
- Return Value
-
- On success the <function>ioctl()</function> function returns
-<returnvalue>0</returnvalue> and does not reset the
-<varname>errno</varname> variable. On failure
-<returnvalue>-1</returnvalue> is returned, when the ioctl takes an
-output or read/write parameter it remains unmodified, and the
-<varname>errno</varname> variable is set appropriately. See below for
-possible error codes. Generic errors like <errorcode>EBADF</errorcode>
-or <errorcode>EFAULT</errorcode> are not listed in the sections
-discussing individual ioctl requests.
- Note ioctls may return undefined error codes. Since errors
-may have side effects such as a driver reset applications should
-abort on unexpected errors.
-
- <variablelist>
- <varlistentry>
- <term><errorcode>EBADF</errorcode></term>
-
- <parameter>fd</parameter> is not a valid open file
-descriptor.
-
- </varlistentry>
- <varlistentry>
- <term><errorcode>EBUSY</errorcode></term>
-
- The property cannot be changed right now. Typically
-this error code is returned when I/O is in progress or the driver
-supports multiple opens and another process locked the property.
-
- </varlistentry>
- <varlistentry>
- <term><errorcode>EFAULT</errorcode></term>
-
- <parameter>argp</parameter> references an inaccessible
-memory area.
-
- </varlistentry>
- <varlistentry>
- <term><errorcode>ENOTTY</errorcode></term>
-
- <parameter>fd</parameter> is not associated with a
-character special device.
-
- </varlistentry>
- <varlistentry>
- <term><errorcode>EINVAL</errorcode></term>
-
- The <parameter>request</parameter> or the data pointed
-to by <parameter>argp</parameter> is not valid. This is a very common
-error code, see the individual ioctl requests listed in <xref
- linkend="user-func" /> for actual causes.
-
- </varlistentry>
- <varlistentry>
- <term><errorcode>ENOMEM</errorcode></term>
-
- Not enough physical or virtual memory was available to
-complete the request.
-
- </varlistentry>
- <varlistentry>
- <term><errorcode>ERANGE</errorcode></term>
-
- The application attempted to set a control with the
-&VIDIOC-S-CTRL; ioctl to a value which is out of bounds.
-
- </varlistentry>
- </variablelist>
+ &return-value;
+ When an ioctl that takes an output or read/write parameter fails,
+ the parameter remains unmodified.
</refsect1>
</refentry>

diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml
index a7f73c9..2b50b63 100644
--- a/Documentation/DocBook/media/v4l/gen-errors.xml
+++ b/Documentation/DocBook/media/v4l/gen-errors.xml
@@ -31,7 +31,8 @@
<row>
<entry>EINVAL or ENOTTY</entry>
<entry>The ioctl is not supported by the driver, actually meaning that
- the required functionality is not available.</entry>
+ the required functionality is not available, or the file
+ descriptor is not for a media device.</entry>
</row>
<row>
<entry>ENOMEM</entry>
@@ -46,3 +47,10 @@

</tgroup>

+
+ Note 1: ioctls may return other error codes. Since errors may have side
+effects such as a driver reset, applications should abort on unexpected errors.
+
+
+ Note 2: Request-specific error codes are listed in the individual
+requests descriptions.
diff --git a/Documentation/DocBook/media/v4l/media-func-ioctl.xml b/Documentation/DocBook/media/v4l/media-func-ioctl.xml
index e0ee285..39478d0 100644
--- a/Documentation/DocBook/media/v4l/media-func-ioctl.xml
+++ b/Documentation/DocBook/media/v4l/media-func-ioctl.xml
@@ -64,6 +64,7 @@

<refsect1>
&return-value;
+
Request-specific error codes are listed in the
individual requests descriptions.
When an ioctl that takes an output or read/write parameter fails,
--
1.7.1