]> git.baikalelectronics.ru Git - kernel.git/commit
media: docs: clarify relationship between crop and selection APIs
authorLuca Ceresoli <luca@lucaceresoli.net>
Mon, 14 May 2018 11:27:24 +0000 (07:27 -0400)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Fri, 25 May 2018 19:23:15 +0000 (15:23 -0400)
commitec66042450a8209db1b947e22251df4f68233416
treeda27b2d060303b49a12c3ea2bcb827e60554265b
parentc2a8bdaeaea1b3451d002735874891c7ce8470cf
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>
Documentation/media/uapi/v4l/common.rst
Documentation/media/uapi/v4l/crop.rst
Documentation/media/uapi/v4l/selection-api-005.rst
Documentation/media/uapi/v4l/selection-api.rst