summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/v4l/crop.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-10 11:57:43 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-10 12:06:28 -0300
commit706f8a9975cb8889742d1f606ff466205ed29805 (patch)
tree53f11f25ecbab359cfa29e56c0effff67e4c0500 /Documentation/media/uapi/v4l/crop.rst
parentfed7b888f69f70fc35c184677b2e8f59cb3945cb (diff)
downloadlinux-0-day-706f8a9975cb8889742d1f606ff466205ed29805.tar.gz
linux-0-day-706f8a9975cb8889742d1f606ff466205ed29805.tar.xz
[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/crop.rst')
-rw-r--r--Documentation/media/uapi/v4l/crop.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/media/uapi/v4l/crop.rst b/Documentation/media/uapi/v4l/crop.rst
index 51b19491c3021..0913822347af6 100644
--- a/Documentation/media/uapi/v4l/crop.rst
+++ b/Documentation/media/uapi/v4l/crop.rst
@@ -15,9 +15,9 @@ offset into a video signal.
Applications can use the following API to select an area in the video
signal, query the default area and the hardware limits.
-**NOTE**: Despite their name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
-:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_S_CROP
-<VIDIOC_G_CROP>` ioctls apply to input as well as output devices.
+.. note:: Despite their name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
+ :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_S_CROP
+ <VIDIOC_G_CROP>` ioctls apply to input as well as output devices.
Scaling requires a source and a target. On a video capture or overlay
device the source is the video signal, and the cropping ioctls determine
@@ -38,9 +38,9 @@ support scaling or the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls. Their size (and position
where applicable) will be fixed in this case.
-**NOTE:** All capture and output devices must support the
-:ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl such that applications can
-determine if scaling takes place.
+.. note:: All capture and output devices must support the
+ :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl such that applications
+ can determine if scaling takes place.
Cropping Structures
@@ -144,8 +144,8 @@ reopening a device, such that piping data into or out of a device will
work without special preparations. More advanced applications should
ensure the parameters are suitable before starting I/O.
-**NOTE:** on the next two examples, a video capture device is assumed;
-change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
+.. note:: On the next two examples, a video capture device is assumed;
+ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
Example: Resetting the cropping parameters
==========================================
@@ -207,7 +207,7 @@ Example: Simple downscaling
Example: Selecting an output area
=================================
-**NOTE:** This example assumes an output device.
+.. note:: This example assumes an output device.
.. code-block:: c
@@ -246,7 +246,7 @@ Example: Selecting an output area
Example: Current scaling factor and pixel aspect
================================================
-**NOTE:** This example assumes a video capture device.
+.. note:: This example assumes a video capture device.
.. code-block:: c