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/vidioc-qbuf.rst | |
parent | fed7b888f69f70fc35c184677b2e8f59cb3945cb (diff) | |
download | op-kernel-dev-706f8a9975cb8889742d1f606ff466205ed29805.zip op-kernel-dev-706f8a9975cb8889742d1f606ff466205ed29805.tar.gz |
[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/vidioc-qbuf.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/vidioc-qbuf.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-qbuf.rst b/Documentation/media/uapi/v4l/vidioc-qbuf.rst index 9870d24..3b927f3 100644 --- a/Documentation/media/uapi/v4l/vidioc-qbuf.rst +++ b/Documentation/media/uapi/v4l/vidioc-qbuf.rst @@ -135,14 +135,15 @@ EINVAL EIO ``VIDIOC_DQBUF`` failed due to an internal error. Can also indicate - temporary problems like signal loss. Note the driver might dequeue - an (empty) buffer despite returning an error, or even stop - capturing. Reusing such buffer may be unsafe though and its details - (e.g. ``index``) may not be returned either. It is recommended that - drivers indicate recoverable errors by setting the - ``V4L2_BUF_FLAG_ERROR`` and returning 0 instead. In that case the - application should be able to safely reuse the buffer and continue - streaming. + temporary problems like signal loss. + + .. note:: The driver might dequeue an (empty) buffer despite returning + an error, or even stop capturing. Reusing such buffer may be unsafe + though and its details (e.g. ``index``) may not be returned either. + It is recommended that drivers indicate recoverable errors by setting + the ``V4L2_BUF_FLAG_ERROR`` and returning 0 instead. In that case the + application should be able to safely reuse the buffer and continue + streaming. EPIPE ``VIDIOC_DQBUF`` returns this on an empty capture queue for mem2mem |