media: docs: uAPI: Clarify error documentation for invalid 'which' value
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Wed, 13 Dec 2023 15:00:07 +0000 (17:00 +0200)
committerHans Verkuil <hverkuil-cisco@xs4all.nl>
Wed, 13 Dec 2023 15:52:35 +0000 (16:52 +0100)
commit2b455a551f2e428d18086393f54ddf921193f208
treeab853002a31b8998ca120a6041fde31763d8eec5
parent6b456240b301956227d8a9b86e13e7d0d4f9429e
media: docs: uAPI: Clarify error documentation for invalid 'which' value

Invalid values for the 'which' field of structures passed to multiple
subdev ioctls result in an EINVAL error being returned. The
documentation of the corresponding ioctls indicates this with sentences
such as the following:

    the ``which`` field references a non-existing format

This is confusing. Clarify the documentation.

Suggested-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst
Documentation/userspace-api/media/v4l/vidioc-subdev-g-fmt.rst
Documentation/userspace-api/media/v4l/vidioc-subdev-g-frame-interval.rst
Documentation/userspace-api/media/v4l/vidioc-subdev-g-selection.rst