summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/dmx-get-stc.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-01 18:15:43 +0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 12:16:37 +0200
commit9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9 (patch)
tree85309ffed01e67b66f32abfff0b2c3eaaac20995 /Documentation/media/uapi/dvb/dmx-get-stc.rst
parentmedia: gen-errors.rst: document ENXIO error code (diff)
downloadlinux-9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9.tar.xz
linux-9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9.zip
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-get-stc.rst')
-rw-r--r--Documentation/media/uapi/dvb/dmx-get-stc.rst15
1 files changed, 11 insertions, 4 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-get-stc.rst b/Documentation/media/uapi/dvb/dmx-get-stc.rst
index 9fc501e8128a..6d5d069d4e6c 100644
--- a/Documentation/media/uapi/dvb/dmx-get-stc.rst
+++ b/Documentation/media/uapi/dvb/dmx-get-stc.rst
@@ -42,17 +42,24 @@ the real 90kHz STC value is stc->stc / stc->base .
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}|
.. flat-table::
:header-rows: 0
:stub-columns: 0
-
+ :widths: 1 16
- .. row 1
- ``EINVAL``
- Invalid stc number.
+
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.