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/ca-fopen.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/ca-fopen.rst')
| -rw-r--r-- | Documentation/media/uapi/dvb/ca-fopen.rst | 32 |
1 files changed, 5 insertions, 27 deletions
diff --git a/Documentation/media/uapi/dvb/ca-fopen.rst b/Documentation/media/uapi/dvb/ca-fopen.rst index 3d2819751446..c974a212b618 100644 --- a/Documentation/media/uapi/dvb/ca-fopen.rst +++ b/Documentation/media/uapi/dvb/ca-fopen.rst @@ -66,33 +66,11 @@ the device in this mode will fail, and an error code will be returned. Return Value ------------ -.. tabularcolumns:: |p{2.5cm}|p{15.0cm}| -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - ``ENODEV`` - - - Device driver not loaded/available. - - - .. row 2 - - - ``EINTERNAL`` - - - Internal error. - - - .. row 3 - - - ``EBUSY`` - - - Device or resource busy. - - - .. row 4 +On success 0 is returned. - - ``EINVAL`` +On error -1 is returned, and the ``errno`` variable is set +appropriately. - - Invalid argument. +Generic error codes are described at the +:ref:`Generic Error Codes <gen-errors>` chapter. |