diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2016-07-08 20:55:43 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-08 17:39:15 -0300 |
| commit | 21c62694499800f74def88edfbd5dcd91c492b79 (patch) | |
| tree | f8998e60c0400ba5475dba3685d9ac0ca1984b9d /Documentation/media/uapi/cec/cec-func-open.rst | |
| parent | e2460b1d579a6ea4f90cf2915da87b16b59e0082 (diff) | |
[media] doc-rst: linux_tc CEC enhanced markup
leaved content unchanged, only improved markup and references
* more man-like sections (add Name section)
* defined target for each stuct field description
* replace constant with ":ref:" to (field) description
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/cec/cec-func-open.rst')
| -rw-r--r-- | Documentation/media/uapi/cec/cec-func-open.rst | 26 |
1 files changed, 9 insertions, 17 deletions
diff --git a/Documentation/media/uapi/cec/cec-func-open.rst b/Documentation/media/uapi/cec/cec-func-open.rst index 4691194ee795..53ffc091e2c0 100644 --- a/Documentation/media/uapi/cec/cec-func-open.rst +++ b/Documentation/media/uapi/cec/cec-func-open.rst @@ -6,10 +6,10 @@ cec open() ********** -*man cec-open(2)* - -Open a cec device +Name +==== +cec-open - Open a cec device Synopsis ======== @@ -19,7 +19,8 @@ Synopsis #include <fcntl.h> -.. c:function:: int open( const char *device_name, int flags ) +.. cpp:function:: int open( const char *device_name, int flags ) + Arguments ========= @@ -31,11 +32,11 @@ Arguments Open flags. Access mode must be ``O_RDWR``. When the ``O_NONBLOCK`` flag is given, the - :ref:`CEC_RECEIVE <cec-ioc-receive>` ioctl will return EAGAIN + :ref:`CEC_RECEIVE` ioctl will return EAGAIN error code when no message is available, and the - :ref:`CEC_TRANSMIT <cec-ioc-receive>`, - :ref:`CEC_ADAP_S_PHYS_ADDR <cec-ioc-adap-g-phys-addr>` and - :ref:`CEC_ADAP_S_LOG_ADDRS <cec-ioc-adap-g-log-addrs>` ioctls + :ref:`CEC_TRANSMIT`, + :ref:`CEC_ADAP_S_PHYS_ADDR` and + :ref:`CEC_ADAP_S_LOG_ADDRS` ioctls all act in non-blocking mode. Other flags have no effect. @@ -77,12 +78,3 @@ ENOMEM ENXIO No device corresponding to this device special file exists. - - -.. ------------------------------------------------------------------------------ -.. This file was automatically converted from DocBook-XML with the dbxml -.. library (https://github.com/return42/sphkerneldoc). The origin XML comes -.. from the linux kernel, refer to: -.. -.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook -.. ------------------------------------------------------------------------------ |