summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/fe-read-snr.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/fe-read-snr.rst
parent4e3b0cab6d18461d74769a5e504a7a95eb2299d8 (diff)
downloadlinux-9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9.tar.gz
linux-9a721b9b4b0e3d0b998a68bd619b2e94f6e99eb9.tar.bz2
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/fe-read-snr.rst')
-rw-r--r--Documentation/media/uapi/dvb/fe-read-snr.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/media/uapi/dvb/fe-read-snr.rst b/Documentation/media/uapi/dvb/fe-read-snr.rst
index 2aed487f5c99..6db22c043512 100644
--- a/Documentation/media/uapi/dvb/fe-read-snr.rst
+++ b/Documentation/media/uapi/dvb/fe-read-snr.rst
@@ -41,6 +41,10 @@ to the device is sufficient.
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
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.