diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-01 12:15:43 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-05 06:16:37 -0400 |
| commit | 9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9 (patch) | |
| tree | 85309ffed01e67b66f32abfff0b2c3eaaac20995 /Documentation/media/uapi/dvb/dmx-fwrite.rst | |
| parent | 4e3b0cab6d18461d74769a5e504a7a95eb2299d8 (diff) | |
media: dvb uAPI docs: adjust return value ioctl descriptions
There are several issues on the return value for ioctls:
- Text is confusing;
- Some error codes don't exist;
- The non-generic error codes should come before the text
that points to the generic error codes;
- Tables don't contain column size hints;
- Some references are not marked as such.
Correct them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/dvb/dmx-fwrite.rst')
| -rw-r--r-- | Documentation/media/uapi/dvb/dmx-fwrite.rst | 29 |
1 files changed, 13 insertions, 16 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-fwrite.rst b/Documentation/media/uapi/dvb/dmx-fwrite.rst index 8a90dfe28307..5e82a9ee418f 100644 --- a/Documentation/media/uapi/dvb/dmx-fwrite.rst +++ b/Documentation/media/uapi/dvb/dmx-fwrite.rst @@ -44,32 +44,29 @@ The amount of data to be transferred is implied by count. Return Value ------------ +On success 0 is returned. + +On error -1 is returned, and the ``errno`` variable is set +appropriately. + .. tabularcolumns:: |p{2.5cm}|p{15.0cm}| .. flat-table:: :header-rows: 0 :stub-columns: 0 + :widths: 1 16 - - .. row 1 - - - ``EWOULDBLOCK`` - - - No data was written. This might happen if O_NONBLOCK was + - - ``EWOULDBLOCK`` + - No data was written. This might happen if ``O_NONBLOCK`` was specified and there is no more buffer space available (if - O_NONBLOCK is not specified the function will block until buffer + ``O_NONBLOCK`` is not specified the function will block until buffer space is available). - - .. row 2 - - - ``EBUSY`` - + - - ``EBUSY`` - This error code indicates that there are conflicting requests. The corresponding demux device is setup to receive data from the front- end. Make sure that these filters are stopped and that the - filters with input set to DMX_IN_DVR are started. - - - .. row 3 - - - ``EBADF`` + filters with input set to ``DMX_IN_DVR`` are started. - - fd is not a valid open file descriptor. +The generic error codes are described at the +:ref:`Generic Error Codes <gen-errors>` chapter. |