From: Mauro Carvalho Chehab Date: Mon, 4 Jul 2016 21:16:57 +0000 (-0300) Subject: doc-rst: linux_tv: Use references for read()/write() X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=f84dd9007fa7280a02263e15fe4c7d1993b620c2;p=linux-beck.git doc-rst: linux_tv: Use references for read()/write() Use cross-references for read()/write() on a few places where they weren't used. Signed-off-by: Mauro Carvalho Chehab --- diff --git a/Documentation/linux_tv/media/v4l/dev-capture.rst b/Documentation/linux_tv/media/v4l/dev-capture.rst index c927b7834b90..16030a8354fd 100644 --- a/Documentation/linux_tv/media/v4l/dev-capture.rst +++ b/Documentation/linux_tv/media/v4l/dev-capture.rst @@ -97,6 +97,6 @@ requests and always returns default parameters as :ref:`VIDIOC_G_FMT ` -and/or streaming (:ref:`memory mapping ` or +A video capture device may support the ::ref:`read() function ` +and/or streaming (:ref:`memory mapping ` or :ref:`user pointer `) I/O. See :ref:`io` for details. diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst index a26e10e92460..3aa93943fe9f 100644 --- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst +++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst @@ -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() ` +, :ref:`write() ` and :ref:`select() ` calls. VBI devices must implement both the :ref:`VIDIOC_G_FMT ` and :ref:`VIDIOC_S_FMT ` ioctl, even if :ref:`VIDIOC_S_FMT ` ignores all requests diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst index 9598c0fd592e..705175be80e6 100644 --- a/Documentation/linux_tv/media/v4l/func-open.rst +++ b/Documentation/linux_tv/media/v4l/func-open.rst @@ -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 ` 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() ` + function and the :ref:`VIDIOC_DQBUF ` 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. diff --git a/Documentation/linux_tv/media/v4l/open.rst b/Documentation/linux_tv/media/v4l/open.rst index c349575efc03..a3e39df91e9d 100644 --- a/Documentation/linux_tv/media/v4l/open.rst +++ b/Documentation/linux_tv/media/v4l/open.rst @@ -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() `/\ :ref:`write() ` API. Today each device node supports just one function.