diff options
author | Hans Verkuil <hverkuil@xs4all.nl> | 2017-07-28 06:31:50 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-08-08 06:35:39 -0400 |
commit | cfaf384ba33d7fed4e0d3483282194abe5eb6fd6 (patch) | |
tree | 796986f31ad712eb6f329d295d5b2da38c7bf3ea /Documentation/media/uapi/cec/cec-func-poll.rst | |
parent | 0f59b2d0138b936d8d65ecbe193d512196199806 (diff) | |
download | linux-cfaf384ba33d7fed4e0d3483282194abe5eb6fd6.tar.bz2 |
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>
Diffstat (limited to 'Documentation/media/uapi/cec/cec-func-poll.rst')
-rw-r--r-- | Documentation/media/uapi/cec/cec-func-poll.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/media/uapi/cec/cec-func-poll.rst b/Documentation/media/uapi/cec/cec-func-poll.rst index fa0abd8fb160..d49f1ee0742d 100644 --- a/Documentation/media/uapi/cec/cec-func-poll.rst +++ b/Documentation/media/uapi/cec/cec-func-poll.rst @@ -39,10 +39,10 @@ Arguments Description =========== -With the :c:func:`poll()` function applications can wait for CEC +With the :c:func:`poll() <cec-poll>` function applications can wait for CEC events. -On success :c:func:`poll()` returns the number of file descriptors +On success :c:func:`poll() <cec-poll>` returns the number of file descriptors that have been selected (that is, file descriptors for which the ``revents`` field of the respective struct :c:type:`pollfd` is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in @@ -53,13 +53,13 @@ then the ``POLLPRI`` flag is set. When the function times out it returns a value of zero, on failure it returns -1 and the ``errno`` variable is set appropriately. -For more details see the :c:func:`poll()` manual page. +For more details see the :c:func:`poll() <cec-poll>` manual page. Return Value ============ -On success, :c:func:`poll()` returns the number structures which have +On success, :c:func:`poll() <cec-poll>` returns the number structures which have non-zero ``revents`` fields, or zero if the call timed out. On error -1 is returned, and the ``errno`` variable is set appropriately: |