iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc-rst: linux_tv: Use references for read()/write()

Browse Source 
Use cross-references for read()/write() on a few places
where they weren't used.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-04 18:16:57 -03:00
parent 863bd721a9
commit f84dd9007f
4 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/linux_tv/media/v4l/dev-capture.rst
View File

@ -97,6 +97,6 @@ requests and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_F
Reading Images
==============
A video capture device may support the :ref:`read() function <rw>`
and/or streaming (:ref:`memory mapping <mmap>` or
A video capture device may support the ::ref:`read() function <func-read>`
and/or streaming (:ref:`memory mapping <func-mmap>` or
:ref:`user pointer <userp>`) I/O. See :ref:`io` for details.

4
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
View File

@ -91,8 +91,8 @@ happen for instance when the video and VBI areas to capture would
overlap, or when the driver supports multiple opens and another process
already requested VBI capturing or output. Anyway, applications must
expect other resource allocation points which may return ``EBUSY``, at the
:ref:`VIDIOC_STREAMON` ioctl and the first read(),
write() and select() call.
:ref:`VIDIOC_STREAMON` ioctl and the first :ref:`read() <func-read>`
, :ref:`write() <func-write>` and :ref:`select() <func-select>` calls.
VBI devices must implement both the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all requests

12
Documentation/linux_tv/media/v4l/func-open.rst
View File

@ -32,12 +32,12 @@ Arguments
technicality, input devices still support only reading and output
devices only writing.
When the ``O_NONBLOCK`` flag is given, the read() function and the
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will return the ``EAGAIN``
error code when no data is available or no buffer is in the driver
outgoing queue, otherwise these functions block until data becomes
available. All V4L2 drivers exchanging data with applications must
support the ``O_NONBLOCK`` flag.
When the ``O_NONBLOCK`` flag is given, the :ref:`read() <func-read>`
function and the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will
return the ``EAGAIN`` error code when no data is available or no
buffer is in the driver outgoing queue, otherwise these functions
block until data becomes available. All V4L2 drivers exchanging data
with applications must support the ``O_NONBLOCK`` flag.
Other flags have no effect.

3
Documentation/linux_tv/media/v4l/open.rst
View File

@ -73,7 +73,8 @@ support all functions. However, in practice this never worked: this
'feature' was never used by applications and many drivers did not
support it and if they did it was certainly never tested. In addition,
switching a device node between different functions only works when
using the streaming I/O API, not with the read()/write() API.
using the streaming I/O API, not with the
:ref:`read() <func-read>`/\ :ref:`write() <func-write>` API.
Today each device node supports just one function.