diff options
author | Mauro Carvalho Chehab | 2016-07-10 13:22:19 +0200 |
---|---|---|
committer | Mauro Carvalho Chehab | 2016-07-10 13:31:24 +0200 |
commit | 282f02cb863594d9f39b7b89a92eeb7fc989a883 (patch) | |
tree | 30287f366a774c53ca4e500234fa9f5ea260ac10 /Documentation/media/uapi/v4l/crop.rst | |
parent | [media] doc-rst: do cross-references between header and the doc (diff) | |
download | kernel-qcow2-linux-282f02cb863594d9f39b7b89a92eeb7fc989a883.tar.gz kernel-qcow2-linux-282f02cb863594d9f39b7b89a92eeb7fc989a883.tar.xz kernel-qcow2-linux-282f02cb863594d9f39b7b89a92eeb7fc989a883.zip |
[media] doc-rst: Don't use captions for examples
Unfortunately, captions are new on Sphinx for c blocks: it was
added only on version 1.3. Also, it were already bad enough
not being able to auto-numerate them.
So, let's give up and use, instead, titles before the examples.
Not much is lost, and, as a side track, we don't need to
numerate them anymore.
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.rst | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/Documentation/media/uapi/v4l/crop.rst b/Documentation/media/uapi/v4l/crop.rst index ed43b36c51d8..51b19491c302 100644 --- a/Documentation/media/uapi/v4l/crop.rst +++ b/Documentation/media/uapi/v4l/crop.rst @@ -147,8 +147,10 @@ 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. +Example: Resetting the cropping parameters +========================================== + .. code-block:: c - :caption: Example 1.11. Resetting the cropping parameters struct v4l2_cropcap cropcap; struct v4l2_crop crop; @@ -173,8 +175,11 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device. exit (EXIT_FAILURE); } + +Example: Simple downscaling +=========================== + .. code-block:: c - :caption: Example 1.12. Simple downscaling struct v4l2_cropcap cropcap; struct v4l2_format format; @@ -199,10 +204,12 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device. /* We could check the actual image size now, the actual scaling factor or if the driver can scale at all. */ +Example: Selecting an output area +================================= + **NOTE:** This example assumes an output device. .. code-block:: c - :caption: Example 1.13. Selecting an output area struct v4l2_cropcap cropcap; struct v4l2_crop crop; @@ -236,10 +243,12 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device. exit (EXIT_FAILURE); } +Example: Current scaling factor and pixel aspect +================================================ + **NOTE:** This example assumes a video capture device. .. code-block:: c - :caption: Example 1.14. Current scaling factor and pixel aspect struct v4l2_cropcap cropcap; struct v4l2_crop crop; |