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/buffer.rst | |
| parent | fed7b888f69f70fc35c184677b2e8f59cb3945cb (diff) | |
| download | lwn-706f8a9975cb8889742d1f606ff466205ed29805.tar.gz lwn-706f8a9975cb8889742d1f606ff466205ed29805.zip | |
[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/buffer.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/buffer.rst | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/Documentation/media/uapi/v4l/buffer.rst b/Documentation/media/uapi/v4l/buffer.rst index b195eb5b63a1..16cdd8e2c4d7 100644 --- a/Documentation/media/uapi/v4l/buffer.rst +++ b/Documentation/media/uapi/v4l/buffer.rst @@ -166,11 +166,11 @@ struct v4l2_buffer output device because the application did not pass new data in time. - Note this may count the frames received e.g. over USB, without - taking into account the frames dropped by the remote hardware due - to limited compression throughput or bus bandwidth. These devices - identify by not enumerating any video standards, see - :ref:`standard`. + .. note:: This may count the frames received e.g. over USB, without + taking into account the frames dropped by the remote hardware due + to limited compression throughput or bus bandwidth. These devices + identify by not enumerating any video standards, see + :ref:`standard`. - .. row 10 @@ -297,8 +297,10 @@ struct v4l2_plane stream, applications when it refers to an output stream. If the application sets this to 0 for an output stream, then ``bytesused`` will be set to the size of the plane (see the - ``length`` field of this struct) by the driver. Note that the - actual image data starts at ``data_offset`` which may not be 0. + ``length`` field of this struct) by the driver. + + .. note:: Note that the actual image data starts at ``data_offset`` + which may not be 0. - .. row 2 @@ -367,10 +369,11 @@ struct v4l2_plane - - Offset in bytes to video data in the plane. Drivers must set this field when ``type`` refers to a capture stream, applications when - it refers to an output stream. Note that data_offset is included - in ``bytesused``. So the size of the image in the plane is - ``bytesused``-``data_offset`` at offset ``data_offset`` from the - start of the plane. + it refers to an output stream. + + .. note:: That data_offset is included in ``bytesused``. So the + size of the image in the plane is ``bytesused``-``data_offset`` + at offset ``data_offset`` from the start of the plane. - .. row 8 |