summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/dmx-start.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-01 12:15:43 -0400
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 06:16:37 -0400
commit9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9 (patch)
tree85309ffed01e67b66f32abfff0b2c3eaaac20995 /Documentation/media/uapi/dvb/dmx-start.rst
parent4e3b0cab6d18461d74769a5e504a7a95eb2299d8 (diff)
downloadop-kernel-dev-9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9.zip
op-kernel-dev-9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9.tar.gz
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-start.rst')
-rw-r--r--Documentation/media/uapi/dvb/dmx-start.rst15
1 files changed, 10 insertions, 5 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-start.rst b/Documentation/media/uapi/dvb/dmx-start.rst
index 641f3e0..36700e7 100644
--- a/Documentation/media/uapi/dvb/dmx-start.rst
+++ b/Documentation/media/uapi/dvb/dmx-start.rst
@@ -29,15 +29,16 @@ Description
-----------
This ioctl call is used to start the actual filtering operation defined
-via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
+via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`.
Return Value
------------
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
@@ -51,7 +52,7 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- Invalid argument, i.e. no filtering parameters provided via the
- DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
+ :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls.
- .. row 2
@@ -61,3 +62,7 @@ appropriately. The generic error codes are described at the
There are active filters filtering data from another input source.
Make sure that these filters are stopped before starting this
filter.
+
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
OpenPOWER on IntegriCloud