Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: v4l2-subdev: Clearly document that the crop API won't be extended

The V4L2 subdev crop API has been marked as obsolete, deprecated by the
selection API. Despite this, it has recently been extended with streams
support. In hindsight this was a mistake. Make sure it doesn't happen
again by clearly documenting that no new extensions will be accepted.

Suggested-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>

authored by

Laurent Pinchart and committed by
Hans Verkuil
c580efb9 cefc10d0

+7 -3
+3 -3
Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
··· 37 37 38 38 .. note:: 39 39 40 - This is an :ref:`obsolete` interface and may be removed 41 - in the future. It is superseded by 42 - :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`. 40 + This is an :ref:`obsolete` interface and may be removed in the future. It is 41 + superseded by :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`. No new 42 + extensions to the :c:type:`v4l2_subdev_crop` structure will be accepted. 43 43 44 44 To retrieve the current crop rectangle applications set the ``pad`` 45 45 field of a struct :c:type:`v4l2_subdev_crop` to the
+4
include/uapi/linux/v4l2-subdev.h
··· 50 50 * @rect: pad crop rectangle boundaries 51 51 * @stream: stream number, defined in subdev routing 52 52 * @reserved: drivers and applications must zero this array 53 + * 54 + * The subdev crop API is an obsolete interface and may be removed in the 55 + * future. It is superseded by the selection API. No new extensions to this 56 + * structure will be accepted. 53 57 */ 54 58 struct v4l2_subdev_crop { 55 59 __u32 which;