Commit 21c62694 authored by Markus Heiser's avatar Markus Heiser Committed by Mauro Carvalho Chehab
Browse files

[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: default avatarMarkus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent e2460b1d

Documentation/media/uapi/cec/cec-api.rst

+1 −10
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ control just the CEC pin. 


Drivers that support CEC will create a CEC device node (/dev/cecX) to

give userspace access to the CEC adapter. The

:ref:`CEC_ADAP_G_CAPS <cec-ioc-adap-g-caps>` ioctl will tell

:ref:`CEC_ADAP_G_CAPS` ioctl will tell

userspace what it is allowed to do.
@@ -83,12 +83,3 @@ Revision and Copyright 
:revision: 1.0.0 / 2016-03-17 (*hv*)



Initial revision
 




.. ------------------------------------------------------------------------------

.. 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

.. ------------------------------------------------------------------------------

Documentation/media/uapi/cec/cec-func-close.rst

+4 −12
Original line number Diff line number Diff line
@@ -6,9 +6,10 @@ 
cec close()

***********



*man cec-close(2)*

Name

====



Close a cec device

cec-close - Close a cec device





Synopsis
@@ -19,7 +20,7 @@ Synopsis 
    #include <unistd.h>





.. c:function:: int close( int fd )

.. cpp:function:: int close( int fd )



Arguments

=========
@@ -46,12 +47,3 @@ Return Value 


EBADF

    ``fd`` is not a valid open file descriptor.
 




.. ------------------------------------------------------------------------------

.. 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

.. ------------------------------------------------------------------------------

Documentation/media/uapi/cec/cec-func-ioctl.rst

+4 −13
Original line number Diff line number Diff line
@@ -6,10 +6,10 @@ 
cec ioctl()

***********



*man cec-ioctl(2)*



Control a cec device

Name

====



cec-ioctl - Control a cec device



Synopsis

========
@@ -19,7 +19,7 @@ Synopsis 
    #include <sys/ioctl.h>





.. c:function:: int ioctl( int fd, int request, void *argp )

.. cpp:function:: int ioctl( int fd, int request, void *argp )



Arguments

=========
@@ -66,12 +66,3 @@ descriptions. 


When an ioctl that takes an output or read/write parameter fails, the

parameter remains unmodified.
 




.. ------------------------------------------------------------------------------

.. 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

.. ------------------------------------------------------------------------------

Documentation/media/uapi/cec/cec-func-open.rst

+9 −17
Original line number Diff line number Diff line
@@ -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

.. ------------------------------------------------------------------------------

Documentation/media/uapi/cec/cec-func-poll.rst

+8 −12
Original line number Diff line number Diff line
@@ -6,9 +6,10 @@ 
cec poll()

**********



*man cec-poll(2)*

Name

====



Wait for some event on a file descriptor

cec-poll - Wait for some event on a file descriptor





Synopsis
@@ -19,7 +20,11 @@ Synopsis 
    #include <sys/poll.h>





.. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )

.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )



Arguments

=========





Description

===========
@@ -63,12 +68,3 @@ EINTR 


EINVAL

    The ``nfds`` argument is greater than ``OPEN_MAX``.
 




.. ------------------------------------------------------------------------------

.. 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

.. ------------------------------------------------------------------------------