[PATCH RFCv3 15/17] [media] DocBook/dvb: Use generic descriptions for the video API

Mauro Carvalho Chehab
2011-07-06T18:04:41Z

While here, removes the bogus EINTERNAL error codes.

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

diff --git a/Documentation/DocBook/media/dvb/video.xml b/Documentation/DocBook/media/dvb/video.xml
index 0b1b662..25fb823 100644
--- a/Documentation/DocBook/media/dvb/video.xml
+++ b/Documentation/DocBook/media/dvb/video.xml
@@ -593,22 +593,6 @@ role="subsection"> VIDEO_STOP
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_PLAY"
role="subsection"> VIDEO_PLAY
@@ -645,22 +629,6 @@ role="subsection"> VIDEO_PLAY
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_FREEZE"
role="subsection"> VIDEO_FREEZE
@@ -701,22 +669,6 @@ role="subsection"> VIDEO_FREEZE
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_CONTINUE"
role="subsection"> VIDEO_CONTINUE
@@ -753,22 +705,6 @@ role="subsection"> VIDEO_CONTINUE
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_SELECT_SOURCE"
role="subsection"> VIDEO_SELECT_SOURCE
@@ -815,22 +751,6 @@ role="subsection"> VIDEO_SELECT_SOURCE
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_SET_BLANK"
role="subsection"> VIDEO_SET_BLANK
@@ -880,29 +800,6 @@ role="subsection"> VIDEO_SET_BLANK
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row><row><entry
- align="char">
- EINVAL
-</entry><entry
- align="char">
- Illegal input parameter
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_GET_STATUS"
role="subsection"> VIDEO_GET_STATUS
@@ -947,29 +844,6 @@ role="subsection"> VIDEO_GET_STATUS
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error, possibly in the communication with the
- DVB subsystem.
-</entry>
- </row><row><entry
- align="char">
- EFAULT
-</entry><entry
- align="char">
- status points to invalid address
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_GET_EVENT"
role="subsection"> VIDEO_GET_EVENT
@@ -1025,20 +899,6 @@ role="subsection"> VIDEO_GET_EVENT
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EFAULT
-</entry><entry
- align="char">
- ev points to invalid address
-</entry>
- </row><row><entry
- align="char">
EWOULDBLOCK
</entry><entry
align="char">
@@ -1050,11 +910,6 @@ role="subsection"> VIDEO_GET_EVENT
EOVERFLOW
</entry><entry
align="char">
-</entry>
- </row><row><entry
- align="char">
-</entry><entry
- align="char">
Overflow in event queue - one or more events were lost.
</entry>
</row> </tgroup></informaltable>
@@ -1105,28 +960,6 @@ role="subsection"> VIDEO_SET_DISPLAY_FORMAT
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error.
-</entry>
- </row><row><entry
- align="char">
- EINVAL
-</entry><entry
- align="char">
- Illegal parameter format.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_STILLPICTURE"
role="subsection"> VIDEO_STILLPICTURE
@@ -1174,28 +1007,6 @@ role="subsection"> VIDEO_STILLPICTURE
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error.
-</entry>
- </row><row><entry
- align="char">
- EFAULT
-</entry><entry
- align="char">
- sp points to an invalid iframe.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_FAST_FORWARD"
role="subsection"> VIDEO_FAST_FORWARD
@@ -1242,32 +1053,11 @@ role="subsection"> VIDEO_FAST_FORWARD
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error.
-</entry>
- </row><row><entry
- align="char">
EPERM
</entry><entry
align="char">
Mode VIDEO_SOURCE_MEMORY not selected.
</entry>
- </row><row><entry
- align="char">
- EINVAL
-</entry><entry
- align="char">
- Illegal parameter format.
-</entry>
</row> </tgroup></informaltable>

<section id="VIDEO_SLOWMOTION"
@@ -1315,32 +1105,11 @@ role="subsection"> VIDEO_SLOWMOTION
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error.
-</entry>
- </row><row><entry
- align="char">
EPERM
</entry><entry
align="char">
Mode VIDEO_SOURCE_MEMORY not selected.
</entry>
- </row><row><entry
- align="char">
- EINVAL
-</entry><entry
- align="char">
- Illegal parameter format.
-</entry>
</row> </tgroup></informaltable>

<section id="VIDEO_GET_CAPABILITIES"
@@ -1388,21 +1157,6 @@ role="subsection"> VIDEO_GET_CAPABILITIES
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EFAULT
-</entry><entry
- align="char">
- cap points to an invalid iframe.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_SET_ID"
role="subsection"> VIDEO_SET_ID
@@ -1449,20 +1203,6 @@ role="subsection"> VIDEO_SET_ID
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor.
-</entry>
- </row><row><entry
- align="char">
- EINTERNAL
-</entry><entry
- align="char">
- Internal error.
-</entry>
- </row><row><entry
- align="char">
EINVAL
</entry><entry
align="char">
@@ -1504,14 +1244,6 @@ role="subsection"> VIDEO_CLEAR_BUFFER
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_SET_STREAMTYPE"
role="subsection"> VIDEO_SET_STREAMTYPE
@@ -1557,21 +1289,6 @@ role="subsection"> VIDEO_SET_STREAMTYPE
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
- EINVAL
-</entry><entry
- align="char">
- type is not a valid or supported stream type.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_SET_FORMAT"
role="subsection"> VIDEO_SET_FORMAT
@@ -1619,13 +1336,6 @@ role="subsection"> VIDEO_SET_FORMAT
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
EINVAL
</entry><entry
align="char">
@@ -1680,13 +1390,6 @@ role="subsection"> VIDEO_SET_SYSTEM
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
EINVAL
</entry><entry
align="char">
@@ -1737,21 +1440,6 @@ role="subsection"> VIDEO_SET_HIGHLIGHT
</entry>
</row> </tgroup></informaltable>
&return-value-dvb;
-<informaltable><tgroup cols="2"> <row><entry
- align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor.
-</entry>
- </row><row><entry
- align="char">
- EINVAL
-</entry><entry
- align="char">
- input is not a valid highlight setting.
-</entry>
- </row> </tgroup></informaltable>

<section id="VIDEO_SET_SPU"
role="subsection"> VIDEO_SET_SPU
@@ -1799,13 +1487,6 @@ role="subsection"> VIDEO_SET_SPU
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
EINVAL
</entry><entry
align="char">
@@ -1859,13 +1540,6 @@ role="subsection"> VIDEO_SET_SPU_PALETTE
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
EINVAL
</entry><entry
align="char">
@@ -1920,13 +1594,6 @@ role="subsection"> VIDEO_GET_NAVI
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
EFAULT
</entry><entry
align="char">
@@ -1981,13 +1648,6 @@ role="subsection"> VIDEO_SET_ATTRIBUTES
&return-value-dvb;
<informaltable><tgroup cols="2"> <row><entry
align="char">
- EBADF
-</entry><entry
- align="char">
- fd is not a valid open file descriptor
-</entry>
- </row><row><entry
- align="char">
EINVAL
</entry><entry
align="char">
--
1.7.1