media: docs: clarify relationship between crop and selection APIs

Browse source

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>

...

This commit is contained in:

Luca Ceresoli 2018-05-14 07:27:24 -04:00 • committed by Mauro Carvalho Chehab

parent e81ff408c1

commit 579d76deb1

4 changed files with 20 additions and 10 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

2

Documentation/media/uapi/v4l/common.rst

View file

22

Documentation/media/uapi/v4l/crop.rst

View file

2

Documentation/media/uapi/v4l/selection-api-005.rst

View file

4

Documentation/media/uapi/v4l/selection-api.rst

View file