aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2016-08-15 10:08:28 -0400
committerJonathan Corbet <corbet@lwn.net>2016-08-22 17:20:00 -0400
commit9cd3476c91708b4b814f17671597a2708ec195ed (patch)
tree9f475a4cad8d380dd44f94f38137473787d0177a
parentaa10a7826646c56eb4553df8fe81b3d23655c91a (diff)
doc-rst: migrate ioctl CEC_DQEVENT to c-domain
This is only one example, demonstrating the benefits of the patch series. The CEC_DQEVENT ioctl is migrated to the sphinx c-domain and referred by ":name: CEC_DQEVENT". With this change the indirection using ":ref:`CEC_DQEVENT` is no longer needed, we can refer the ioctl directly with ":c:func:`CEC_DQEVENT`". As addition in the index, there is a entry "CEC_DQEVENT (C function)". Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/media/uapi/cec/cec-func-open.rst2
-rw-r--r--Documentation/media/uapi/cec/cec-ioc-dqevent.rst5
2 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/media/uapi/cec/cec-func-open.rst b/Documentation/media/uapi/cec/cec-func-open.rst
index 38fd7e0cfccd..7c0f981a6e07 100644
--- a/Documentation/media/uapi/cec/cec-func-open.rst
+++ b/Documentation/media/uapi/cec/cec-func-open.rst
@@ -32,7 +32,7 @@ Arguments
32 Open flags. Access mode must be ``O_RDWR``. 32 Open flags. Access mode must be ``O_RDWR``.
33 33
34 When the ``O_NONBLOCK`` flag is given, the 34 When the ``O_NONBLOCK`` flag is given, the
35 :ref:`CEC_RECEIVE <CEC_RECEIVE>` and :ref:`CEC_DQEVENT <CEC_DQEVENT>` ioctls 35 :ref:`CEC_RECEIVE <CEC_RECEIVE>` and :c:func:`CEC_DQEVENT` ioctls
36 will return the ``EAGAIN`` error code when no message or event is available, and 36 will return the ``EAGAIN`` error code when no message or event is available, and
37 ioctls :ref:`CEC_TRANSMIT <CEC_TRANSMIT>`, 37 ioctls :ref:`CEC_TRANSMIT <CEC_TRANSMIT>`,
38 :ref:`CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>` and 38 :ref:`CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>` and
diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
index 7a6d6d00ce19..4e12e6cd88ee 100644
--- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
@@ -15,7 +15,8 @@ CEC_DQEVENT - Dequeue a CEC event
15Synopsis 15Synopsis
16======== 16========
17 17
18.. cpp:function:: int ioctl( int fd, int request, struct cec_event *argp ) 18.. c:function:: int ioctl( int fd, int request, struct cec_event *argp )
19 :name: CEC_DQEVENT
19 20
20Arguments 21Arguments
21========= 22=========
@@ -36,7 +37,7 @@ Description
36 and is currently only available as a staging kernel module. 37 and is currently only available as a staging kernel module.
37 38
38CEC devices can send asynchronous events. These can be retrieved by 39CEC devices can send asynchronous events. These can be retrieved by
39calling :ref:`ioctl CEC_DQEVENT <CEC_DQEVENT>`. If the file descriptor is in 40calling :c:func:`CEC_DQEVENT`. If the file descriptor is in
40non-blocking mode and no event is pending, then it will return -1 and 41non-blocking mode and no event is pending, then it will return -1 and
41set errno to the ``EAGAIN`` error code. 42set errno to the ``EAGAIN`` error code.
42 43