[PATCH] [media] Documentation: Fix V4L2_CTRL_FLAG_VOLATILE

From: Ricardo Ribalda Delgado
Date: Fri Jul 22 2016 - 10:07:46 EST


V4L2_CTRL_FLAG_VOLATILE behaviour when V4L2_CTRL_FLAG_EXECUTE_ON_WRITE
is set was not properly explained.

Reported-by: Dimitrios Katsaros <patcherwork@xxxxxxxxx>
Credit-to: Hans Verkuil <hansverk@xxxxxxxxx>
Signed-off-by: Ricardo Ribalda Delgado <ricardo.ribalda@xxxxxxxxx>
---
Documentation/media/uapi/v4l/vidioc-queryctrl.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
index 8d6e61a7284d..3a30d6cf70b4 100644
--- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
+++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
@@ -728,10 +728,10 @@ See also the examples in :ref:`control`.
case the hardware calculates the gain value based on the lighting
conditions which can change over time.

- .. 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.
+ .. note:: Setting a new value for a volatile control will be ignored
+ unless `V4L2_CTRL_FLAG_EXECUTE_ON_WRITE`` flag (see below) is also set.
+ Setting a new value for a volatile contol will never trigger a
+ ``V4L2_EVENT_CTRL_CH_VALUE`` event.

- .. row 9

--
2.8.1