diff options
| author |   Markus Heiser <markus.heiser@darmarIT.de> | 2016-08-15 16:08:28 +0200 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2016-08-22 15:20:00 -0600 |
| commit | 9cd3476c91708b4b814f17671597a2708ec195ed (patch) | |
| tree | 9f475a4cad8d380dd44f94f38137473787d0177a /Documentation/media/uapi/cec/cec-ioc-dqevent.rst | |
| parent | doc-rst: Revert "kernel-doc: fix handling of address_space tags" (diff) | |
| download | linux-dev-9cd3476c91708b4b814f17671597a2708ec195ed.tar.xz linux-dev-9cd3476c91708b4b814f17671597a2708ec195ed.zip | |
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>
Diffstat (limited to 'Documentation/media/uapi/cec/cec-ioc-dqevent.rst')
| -rw-r--r-- | Documentation/media/uapi/cec/cec-ioc-dqevent.rst | 5 |
1 files changed, 3 insertions, 2 deletions
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 Synopsis ======== -.. cpp:function:: int ioctl( int fd, int request, struct cec_event *argp ) +.. c:function:: int ioctl( int fd, int request, struct cec_event *argp ) + :name: CEC_DQEVENT Arguments ========= @@ -36,7 +37,7 @@ Description and is currently only available as a staging kernel module. CEC devices can send asynchronous events. These can be retrieved by -calling :ref:`ioctl CEC_DQEVENT <CEC_DQEVENT>`. If the file descriptor is in +calling :c:func:`CEC_DQEVENT`. If the file descriptor is in non-blocking mode and no event is pending, then it will return -1 and set errno to the ``EAGAIN`` error code. |