forked from luck/tmp_suning_uos_patched
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>
This commit is contained in:
parent
0f59b2d013
commit
cfaf384ba3
|
@ -40,7 +40,7 @@ freed. The device configuration remain unchanged.
|
|||
Return Value
|
||||
============
|
||||
|
||||
:c:func:`close()` returns 0 on success. On error, -1 is returned, and
|
||||
:c:func:`close() <cec-close>` returns 0 on success. On error, -1 is returned, and
|
||||
``errno`` is set appropriately. Possible error codes are:
|
||||
|
||||
``EBADF``
|
||||
|
|
|
@ -39,7 +39,7 @@ Arguments
|
|||
Description
|
||||
===========
|
||||
|
||||
The :c:func:`ioctl()` function manipulates cec device parameters. The
|
||||
The :c:func:`ioctl() <cec-ioctl>` function manipulates cec device parameters. The
|
||||
argument ``fd`` must be an open file descriptor.
|
||||
|
||||
The ioctl ``request`` code specifies the cec function to be called. It
|
||||
|
|
|
@ -46,7 +46,7 @@ Arguments
|
|||
Description
|
||||
===========
|
||||
|
||||
To open a cec device applications call :c:func:`open()` with the
|
||||
To open a cec device applications call :c:func:`open() <cec-open>` with the
|
||||
desired device name. The function has no side effects; the device
|
||||
configuration remain unchanged.
|
||||
|
||||
|
@ -58,7 +58,7 @@ EBADF.
|
|||
Return Value
|
||||
============
|
||||
|
||||
:c:func:`open()` returns the new file descriptor on success. On error,
|
||||
:c:func:`open() <cec-open>` returns the new file descriptor on success. On error,
|
||||
-1 is returned, and ``errno`` is set appropriately. Possible error codes
|
||||
include:
|
||||
|
||||
|
|
|
@ -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:
|
||||
|
||||
|
|
|
@ -21,7 +21,7 @@ Arguments
|
|||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by :ref:`open() <cec-func-open>`.
|
||||
File descriptor returned by :c:func:`open() <cec-open>`.
|
||||
|
||||
``argp``
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ Arguments
|
|||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by :ref:`open() <cec-func-open>`.
|
||||
File descriptor returned by :c:func:`open() <cec-open>`.
|
||||
|
||||
``argp``
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user