Commit 9a721b9b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 4e3b0cab

Documentation/media/uapi/dvb/ca-fclose.rst

+5 −8
Original line number Diff line number Diff line
@@ -34,13 +34,10 @@ This system call closes a previously opened CA device. 
Return Value

------------



.. flat-table::

    :header-rows:  0

    :stub-columns: 0

On success 0 is returned.



On error -1 is returned, and the ``errno`` variable is set

appropriately.



    -  .. row 1



       -  ``EBADF``



       -  fd is not a valid open file descriptor.
 
Generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/media/uapi/dvb/ca-fopen.rst

+5 −27
Original line number Diff line number Diff line
@@ -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.

Documentation/media/uapi/dvb/ca-get-cap.rst

+3 −1
Original line number Diff line number Diff line
@@ -40,5 +40,7 @@ Return Value 
On success 0 is returned and :c:type:`ca_caps` is filled.



On error, -1 is returned and the ``errno`` variable is set

appropriately. The generic error codes are described at the

appropriately.



The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/media/uapi/dvb/ca-get-msg.rst

+7 −2
Original line number Diff line number Diff line
@@ -49,6 +49,11 @@ Description 
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.

Documentation/media/uapi/dvb/ca-get-slot-info.rst

+9 −1
Original line number Diff line number Diff line
@@ -43,7 +43,15 @@ On success 0 is returned, and :c:type:`ca_slot_info` is filled. 
On error -1 is returned, and the ``errno`` variable is set

appropriately.



If the slot is not available, ``errno`` will contain ``-EINVAL``.

.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|



.. flat-table::

    :header-rows:  0

    :stub-columns: 0

    :widths: 1 16



    -  -  ``ENODEV``

       -  the slot is not available.



The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

CRA Git | Maintained and supported by SUSTech CRA and CCSE