summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorRicardo Ribalda <ricardo.ribalda@gmail.com>2016-07-22 16:09:06 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-24 10:02:07 -0300
commitf22bede31378119e439758ea56f4f79462199a0d (patch)
treebb3328f9d3321a18186128a24fab99fe5b35a396 /Documentation
parent3f8d56b0223d18b58597331cdf8422348dd51870 (diff)
[media] Documentation: Fix V4L2_CTRL_FLAG_VOLATILE
V4L2_CTRL_FLAG_VOLATILE behaviour when V4L2_CTRL_FLAG_EXECUTE_ON_WRITE is set was not properly explained. Also set some hyperlink to ease the Documentation browsing. Credit-to: Hans Verkuil <hansverk@cisco.com> [mchehab@s-opensource.com: fix a trivial merge conflict] Reported-by: Dimitrios Katsaros <patcherwork@gmail.com> Signed-off-by: Ricardo Ribalda Delgado <ricardo.ribalda@gmail.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/media/uapi/v4l/vidioc-queryctrl.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
index 5817264e11ca..db3ad928ec1c 100644
--- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
+++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
@@ -754,10 +754,12 @@ See also the examples in :ref:`control`.
.. note::
- Setting a new value for a volatile control will have no
- effect and no ``V4L2_EVENT_CTRL_CH_VALUE`` will be sent, unless
- the ``V4L2_CTRL_FLAG_EXECUTE_ON_WRITE`` flag (see below) is
- also set. Otherwise the new value will just be ignored.
+ Setting a new value for a volatile control will be ignored
+ unless
+ :ref:`V4L2_CTRL_FLAG_EXECUTE_ON_WRITE <FLAG_EXECUTE_ON_WRITE>`
+ is also set.
+ Setting a new value for a volatile control will *never* trigger a
+ :ref:`V4L2_EVENT_CTRL_CH_VALUE <ctrl-changes-flags>` event.
- .. row 9
@@ -773,6 +775,7 @@ See also the examples in :ref:`control`.
payload of the control.
- .. row 10
+ .. _FLAG_EXECUTE_ON_WRITE:
- ``V4L2_CTRL_FLAG_EXECUTE_ON_WRITE``