From af4a4d0db8ab2c4e2088bc48cfa49511b766dca6 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 1 Jul 2016 13:42:29 -0300 Subject: doc-rst: linux_tv: Replace reference names to match ioctls Due to a limitation at the DocBook language, the references were using lowercase and slashes, instead of the name of the ioctls. On ReST, make them identical. This will hopefully help to cleanup the code a little bit. Signed-off-by: Mauro Carvalho Chehab --- Documentation/linux_tv/media/v4l/func-poll.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'Documentation/linux_tv/media/v4l/func-poll.rst') diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst index d3ad7b8d1a90..28a769af9309 100644 --- a/Documentation/linux_tv/media/v4l/func-poll.rst +++ b/Documentation/linux_tv/media/v4l/func-poll.rst @@ -30,9 +30,9 @@ output. When streaming I/O has been negotiated this function waits until a buffer has been filled by the capture device and can be dequeued with -the :ref:`VIDIOC_DQBUF ` ioctl. For output devices this +the :ref:`VIDIOC_DQBUF ` ioctl. For output devices this function waits until the device is ready to accept a new buffer to be -queued up with the :ref:`VIDIOC_QBUF ` ioctl for +queued up with the :ref:`VIDIOC_QBUF ` ioctl for display. When buffers are already in the outgoing queue of the driver (capture) or the incoming queue isn't full (display) the function returns immediately. @@ -45,17 +45,17 @@ flags in the ``revents`` field, output devices the ``POLLOUT`` and ``POLLWRNORM`` flags. When the function timed out it returns a value of zero, on failure it returns -1 and the ``errno`` variable is set appropriately. When the application did not call -:ref:`VIDIOC_STREAMON ` the :c:func:`poll()` +:ref:`VIDIOC_STREAMON ` the :c:func:`poll()` function succeeds, but sets the ``POLLERR`` flag in the ``revents`` field. When the application has called -:ref:`VIDIOC_STREAMON ` for a capture device but -hasn't yet called :ref:`VIDIOC_QBUF `, the +:ref:`VIDIOC_STREAMON ` for a capture device but +hasn't yet called :ref:`VIDIOC_QBUF `, the :c:func:`poll()` function succeeds and sets the ``POLLERR`` flag in the ``revents`` field. For output devices this same situation will cause :c:func:`poll()` to succeed as well, but it sets the ``POLLOUT`` and ``POLLWRNORM`` flags in the ``revents`` field. -If an event occurred (see :ref:`VIDIOC_DQEVENT `) +If an event occurred (see :ref:`VIDIOC_DQEVENT `) then ``POLLPRI`` will be set in the ``revents`` field and :c:func:`poll()` will return. -- cgit v1.2.3