]> git.karo-electronics.de Git - linux-beck.git/commitdiff
doc-rst: linux_tv: Use references for read()/write()
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 4 Jul 2016 21:16:57 +0000 (18:16 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 4 Jul 2016 21:16:57 +0000 (18:16 -0300)
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>
Documentation/linux_tv/media/v4l/dev-capture.rst
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
Documentation/linux_tv/media/v4l/func-open.rst
Documentation/linux_tv/media/v4l/open.rst

index c927b7834b9089ae72bcef802cfb2eefb673236e..16030a8354fd53117ef5643958aeff1a48070a43 100644 (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.
index a26e10e92460afa9936b3d1e52e5765f505c7aaa..3aa93943fe9f3048408b0a06801fd87975a6d8f4 100644 (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
index 9598c0fd592e6e1ce852c8741b937e286778ff34..705175be80e6c9467381ebb465c213d6ebe3c7c4 100644 (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.
 
index c349575efc0381120c2aafc47c849bdbc9ac60fe..a3e39df91e9dc6705384d7b0780e0165d5135069 100644 (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.