diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-10 11:57:43 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-10 12:06:28 -0300 |
commit | 706f8a9975cb8889742d1f606ff466205ed29805 (patch) | |
tree | 53f11f25ecbab359cfa29e56c0effff67e4c0500 /Documentation/media/uapi/v4l/mmap.rst | |
parent | fed7b888f69f70fc35c184677b2e8f59cb3945cb (diff) |
[media] doc-rst: improve display of notes and warnings
There are several notes and warning mesages in the middle of
the media docbook. Use the ReST tags for that, as it makes
them visually better and hightlights them.
While here, modify a few ones to make them clearer.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/mmap.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/mmap.rst | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/Documentation/media/uapi/v4l/mmap.rst b/Documentation/media/uapi/v4l/mmap.rst index b01f4486499a..260c2db8916b 100644 --- a/Documentation/media/uapi/v4l/mmap.rst +++ b/Documentation/media/uapi/v4l/mmap.rst @@ -245,12 +245,14 @@ available. The :ref:`select() <func-select>` or :ref:`poll() To start and stop capturing or output applications call the :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and :ref:`VIDIOC_STREAMOFF -<VIDIOC_STREAMON>` ioctl. Note :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` -removes all buffers from both queues as a side effect. Since there is -no notion of doing anything "now" on a multitasking system, if an -application needs to synchronize with another event it should examine -the struct ::ref:`v4l2_buffer <v4l2-buffer>` ``timestamp`` of captured -or outputted buffers. +<VIDIOC_STREAMON>` ioctl. + +.. note:::ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` + removes all buffers from both queues as a side effect. Since there is + no notion of doing anything "now" on a multitasking system, if an + application needs to synchronize with another event it should examine + the struct ::ref:`v4l2_buffer <v4l2-buffer>` ``timestamp`` of captured + or outputted buffers. Drivers implementing memory mapping I/O must support the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, :ref:`VIDIOC_QUERYBUF |