tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

media: cec: documentation fixes

Various references to open() et al were wrong. Fix this so following
the link will get you to the correct place.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab cfaf384b 0f59b2d0

+10 -10
+1 -1
Documentation/media/uapi/cec/cec-func-close.rst
··· 40 40 Return Value 41 41 ============ 42 42 43 - :c:func:`close()` returns 0 on success. On error, -1 is returned, and 43 + :c:func:`close() <cec-close>` returns 0 on success. On error, -1 is returned, and 44 44 ``errno`` is set appropriately. Possible error codes are: 45 45 46 46 ``EBADF``
+1 -1
Documentation/media/uapi/cec/cec-func-ioctl.rst
··· 39 39 Description 40 40 =========== 41 41 42 - The :c:func:`ioctl()` function manipulates cec device parameters. The 42 + The :c:func:`ioctl() <cec-ioctl>` function manipulates cec device parameters. The 43 43 argument ``fd`` must be an open file descriptor. 44 44 45 45 The ioctl ``request`` code specifies the cec function to be called. It
+2 -2
Documentation/media/uapi/cec/cec-func-open.rst
··· 46 46 Description 47 47 =========== 48 48 49 - To open a cec device applications call :c:func:`open()` with the 49 + To open a cec device applications call :c:func:`open() <cec-open>` with the 50 50 desired device name. The function has no side effects; the device 51 51 configuration remain unchanged. 52 52 ··· 58 58 Return Value 59 59 ============ 60 60 61 - :c:func:`open()` returns the new file descriptor on success. On error, 61 + :c:func:`open() <cec-open>` returns the new file descriptor on success. On error, 62 62 -1 is returned, and ``errno`` is set appropriately. Possible error codes 63 63 include: 64 64
+4 -4
Documentation/media/uapi/cec/cec-func-poll.rst
··· 39 39 Description 40 40 =========== 41 41 42 - With the :c:func:`poll()` function applications can wait for CEC 42 + With the :c:func:`poll() <cec-poll>` function applications can wait for CEC 43 43 events. 44 44 45 - On success :c:func:`poll()` returns the number of file descriptors 45 + On success :c:func:`poll() <cec-poll>` returns the number of file descriptors 46 46 that have been selected (that is, file descriptors for which the 47 47 ``revents`` field of the respective struct :c:type:`pollfd` 48 48 is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in ··· 53 53 a value of zero, on failure it returns -1 and the ``errno`` variable is 54 54 set appropriately. 55 55 56 - For more details see the :c:func:`poll()` manual page. 56 + For more details see the :c:func:`poll() <cec-poll>` manual page. 57 57 58 58 59 59 Return Value 60 60 ============ 61 61 62 - On success, :c:func:`poll()` returns the number structures which have 62 + On success, :c:func:`poll() <cec-poll>` returns the number structures which have 63 63 non-zero ``revents`` fields, or zero if the call timed out. On error -1 64 64 is returned, and the ``errno`` variable is set appropriately: 65 65
+1 -1
Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
··· 21 21 ========= 22 22 23 23 ``fd`` 24 - File descriptor returned by :ref:`open() <cec-func-open>`. 24 + File descriptor returned by :c:func:`open() <cec-open>`. 25 25 26 26 ``argp`` 27 27
+1 -1
Documentation/media/uapi/cec/cec-ioc-dqevent.rst
··· 22 22 ========= 23 23 24 24 ``fd`` 25 - File descriptor returned by :ref:`open() <cec-func-open>`. 25 + File descriptor returned by :c:func:`open() <cec-open>`. 26 26 27 27 ``argp`` 28 28