summaryrefslogtreecommitdiffstats
path: root/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-04-02 01:37:25 +0200
committerHans Verkuil <hverkuil-cisco@xs4all.nl>2024-04-29 14:56:36 +0200
commitc580efb94abed05f99bb80245abe96cf5d49128c (patch)
tree47174ee62a261f3b9b888b4766735b1cb63c0881 /Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
parentmedia: si2165: Remove redundant NULL check before release_firmware() call (diff)
downloadlinux-c580efb94abed05f99bb80245abe96cf5d49128c.tar.xz
linux-c580efb94abed05f99bb80245abe96cf5d49128c.zip
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>
Diffstat (limited to 'Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst')
-rw-r--r--Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
index 92d933631fda..88a748103a71 100644
--- a/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
@@ -37,9 +37,9 @@ Description
.. note::
- This is an :ref:`obsolete` interface and may be removed
- in the future. It is superseded by
- :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.
+ This is an :ref:`obsolete` interface and may be removed in the future. It is
+ superseded by :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`. No new
+ extensions to the :c:type:`v4l2_subdev_crop` structure will be accepted.
To retrieve the current crop rectangle applications set the ``pad``
field of a struct :c:type:`v4l2_subdev_crop` to the