summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-03 11:17:12 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-03 11:17:12 -0300
commit8e97cd94319ee7121bb254657f01681fc7e45693 (patch)
tree6a58275696689126ab648c7fe1a41d87fb893491 /Documentation
parentcdaa78fe920f67cce94786152bc7b697da1892b7 (diff)
doc-rst: selection-api-005: Fix ReST parsing
The ReST markup is limited: it doesn't accept a const just after a reference. So, change the documentation to avoid such constraint. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/linux_tv/media/v4l/selection-api-005.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/linux_tv/media/v4l/selection-api-005.rst b/Documentation/linux_tv/media/v4l/selection-api-005.rst
index 6fdb0af2b13d..78448023a79a 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-005.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-005.rst
@@ -15,10 +15,11 @@ appropriate targets. The V4L2 API lacks any support for composing to and
cropping from an image inside a memory buffer. The application could
configure a capture device to fill only a part of an image by abusing
V4L2 API. Cropping a smaller image from a larger one is achieved by
-setting the field struct
-:ref:`v4l2_pix_format <v4l2-pix-format>```::bytesperline``.
-Introducing an image offsets could be done by modifying field struct
-:ref:`v4l2_buffer <v4l2-buffer>```::m_userptr`` before calling
+setting the field ``bytesperline`` at struct
+:ref:`v4l2_pix_format <v4l2-pix-format>`.
+Introducing an image offsets could be done by modifying field ``m_userptr``
+at struct
+:ref:`v4l2_buffer <v4l2-buffer>` before calling
:ref:`VIDIOC_QBUF`. Those operations should be avoided because they are not
portable (endianness), and do not work for macroblock and Bayer formats
and mmap buffers. The selection API deals with configuration of buffer