Commit b2a58436 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] doc-dst: visually improve the CEC pages

Adjust the widths and show error codes as constants.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 21c62694
...@@ -45,5 +45,5 @@ Return Value ...@@ -45,5 +45,5 @@ Return Value
:c:func:`close()` returns 0 on success. On error, -1 is returned, and :c:func:`close()` returns 0 on success. On error, -1 is returned, and
``errno`` is set appropriately. Possible error codes are: ``errno`` is set appropriately. Possible error codes are:
EBADF ``EBADF``
``fd`` is not a valid open file descriptor. ``fd`` is not a valid open file descriptor.
...@@ -64,17 +64,17 @@ Return Value ...@@ -64,17 +64,17 @@ Return Value
-1 is returned, and ``errno`` is set appropriately. Possible error codes -1 is returned, and ``errno`` is set appropriately. Possible error codes
include: include:
EACCES ``EACCES``
The requested access to the file is not allowed. The requested access to the file is not allowed.
EMFILE ``EMFILE``
The process already has the maximum number of files open. The process already has the maximum number of files open.
ENFILE ``ENFILE``
The system limit on the total number of open files has been reached. The system limit on the total number of open files has been reached.
ENOMEM ``ENOMEM``
Insufficient kernel memory was available. Insufficient kernel memory was available.
ENXIO ``ENXIO``
No device corresponding to this device special file exists. No device corresponding to this device special file exists.
...@@ -56,15 +56,15 @@ On success, :c:func:`poll()` returns the number structures which have ...@@ -56,15 +56,15 @@ On success, :c:func:`poll()` returns the number structures which have
non-zero ``revents`` fields, or zero if the call timed out. On error -1 non-zero ``revents`` fields, or zero if the call timed out. On error -1
is returned, and the ``errno`` variable is set appropriately: is returned, and the ``errno`` variable is set appropriately:
EBADF ``EBADF``
One or more of the ``ufds`` members specify an invalid file One or more of the ``ufds`` members specify an invalid file
descriptor. descriptor.
EFAULT ``EFAULT``
``ufds`` references an inaccessible memory area. ``ufds`` references an inaccessible memory area.
EINTR ``EINTR``
The call was interrupted by a signal. The call was interrupted by a signal.
EINVAL ``EINVAL``
The ``nfds`` argument is greater than ``OPEN_MAX``. The ``nfds`` argument is greater than ``OPEN_MAX``.
...@@ -45,7 +45,7 @@ returns the information to the application. The ioctl never fails. ...@@ -45,7 +45,7 @@ returns the information to the application. The ioctl never fails.
.. flat-table:: struct cec_caps .. flat-table:: struct cec_caps
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 16
- .. row 1 - .. row 1
...@@ -90,7 +90,7 @@ returns the information to the application. The ioctl never fails. ...@@ -90,7 +90,7 @@ returns the information to the application. The ioctl never fails.
.. flat-table:: CEC Capabilities Flags .. flat-table:: CEC Capabilities Flags
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 8
- .. _`CEC_CAP_PHYS_ADDR`: - .. _`CEC_CAP_PHYS_ADDR`:
......
...@@ -58,7 +58,7 @@ by a file handle in initiator mode (see ...@@ -58,7 +58,7 @@ by a file handle in initiator mode (see
.. flat-table:: struct cec_log_addrs .. flat-table:: struct cec_log_addrs
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 16
- .. row 1 - .. row 1
...@@ -292,7 +292,7 @@ by a file handle in initiator mode (see ...@@ -292,7 +292,7 @@ by a file handle in initiator mode (see
.. flat-table:: CEC Logical Address Types .. flat-table:: CEC Logical Address Types
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 16
- .. _`CEC_LOG_ADDR_TYPE_TV`: - .. _`CEC_LOG_ADDR_TYPE_TV`:
......
...@@ -55,7 +55,7 @@ state did change in between the two events. ...@@ -55,7 +55,7 @@ state did change in between the two events.
.. flat-table:: struct cec_event_state_change .. flat-table:: struct cec_event_state_change
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 8
- .. row 1 - .. row 1
...@@ -81,7 +81,7 @@ state did change in between the two events. ...@@ -81,7 +81,7 @@ state did change in between the two events.
.. flat-table:: struct cec_event_lost_msgs .. flat-table:: struct cec_event_lost_msgs
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 16
- .. row 1 - .. row 1
...@@ -107,7 +107,7 @@ state did change in between the two events. ...@@ -107,7 +107,7 @@ state did change in between the two events.
.. flat-table:: struct cec_event .. flat-table:: struct cec_event
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 1 :widths: 1 1 1 8
- .. row 1 - .. row 1
...@@ -176,7 +176,7 @@ state did change in between the two events. ...@@ -176,7 +176,7 @@ state did change in between the two events.
.. flat-table:: CEC Events Types .. flat-table:: CEC Events Types
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 16
- .. _CEC_EVENT_STATE_CHANGE: - .. _CEC_EVENT_STATE_CHANGE:
...@@ -205,7 +205,7 @@ state did change in between the two events. ...@@ -205,7 +205,7 @@ state did change in between the two events.
.. flat-table:: CEC Event Flags .. flat-table:: CEC Event Flags
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 8
- .. _CEC_EVENT_FL_INITIAL_VALUE: - .. _CEC_EVENT_FL_INITIAL_VALUE:
......
...@@ -79,7 +79,7 @@ Available initiator modes are: ...@@ -79,7 +79,7 @@ Available initiator modes are:
.. flat-table:: Initiator Modes .. flat-table:: Initiator Modes
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 16
- .. _`CEC_MODE_NO_INITIATOR`: - .. _`CEC_MODE_NO_INITIATOR`:
...@@ -122,7 +122,7 @@ Available follower modes are: ...@@ -122,7 +122,7 @@ Available follower modes are:
.. flat-table:: Follower Modes .. flat-table:: Follower Modes
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 16
- .. _`CEC_MODE_NO_FOLLOWER`: - .. _`CEC_MODE_NO_FOLLOWER`:
...@@ -214,6 +214,7 @@ Core message processing details: ...@@ -214,6 +214,7 @@ Core message processing details:
.. flat-table:: Core Message Processing .. flat-table:: Core Message Processing
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 8
- .. _`CEC_MSG_GET_CEC_VERSION`: - .. _`CEC_MSG_GET_CEC_VERSION`:
......
...@@ -57,7 +57,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -57,7 +57,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
.. flat-table:: struct cec_msg .. flat-table:: struct cec_msg
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 16
- .. row 1 - .. row 1
...@@ -214,7 +214,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -214,7 +214,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
.. flat-table:: CEC Transmit Status .. flat-table:: CEC Transmit Status
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 16
- .. _`CEC_TX_STATUS_OK`: - .. _`CEC_TX_STATUS_OK`:
...@@ -282,7 +282,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -282,7 +282,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
.. flat-table:: CEC Receive Status .. flat-table:: CEC Receive Status
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 4 :widths: 3 1 16
- .. _`CEC_RX_STATUS_OK`: - .. _`CEC_RX_STATUS_OK`:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment