diff options
| author | Luca Ceresoli <luca@lucaceresoli.net> | 2018-05-14 13:27:24 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2018-05-25 21:23:15 +0200 |
| commit | 579d76deb1b106af5987670389604381c31116eb (patch) | |
| tree | da27b2d060303b49a12c3ea2bcb827e60554265b /Documentation/media/uapi/v4l/selection-api.rst | |
| parent | media: docs: selection: fix typos (diff) | |
| download | linux-579d76deb1b106af5987670389604381c31116eb.tar.xz linux-579d76deb1b106af5987670389604381c31116eb.zip | |
media: docs: clarify relationship between crop and selection APIs
Having two somewhat similar and largely overlapping APIs is confusing,
especially since the older one appears in the docs before the newer
and most featureful counterpart.
Clarify all of this in several ways:
- swap the two sections
- give a name to the two APIs in the section names
- add a note at the beginning of the CROP API section
- update note about VIDIOC_CROPCAP
Also remove a note that is incorrect (correct wording is in
vidioc-cropcap.rst).
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Diffstat (limited to 'Documentation/media/uapi/v4l/selection-api.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/selection-api.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/media/uapi/v4l/selection-api.rst b/Documentation/media/uapi/v4l/selection-api.rst index 81ea52d785b9..e4e623824b30 100644 --- a/Documentation/media/uapi/v4l/selection-api.rst +++ b/Documentation/media/uapi/v4l/selection-api.rst @@ -2,8 +2,8 @@ .. _selection-api: -API for cropping, composing and scaling -======================================= +Cropping, composing and scaling -- the SELECTION API +==================================================== .. toctree:: |