diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-10 17:57:43 +0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-10 18:06:28 +0300 |
commit | 706f8a9975cb8889742d1f606ff466205ed29805 (patch) | |
tree | 53f11f25ecbab359cfa29e56c0effff67e4c0500 /Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst | |
parent | fed7b888f69f70fc35c184677b2e8f59cb3945cb (diff) | |
download | linux-706f8a9975cb8889742d1f606ff466205ed29805.tar.xz |
[media] doc-rst: improve display of notes and warnings
There are several notes and warning mesages in the middle of
the media docbook. Use the ReST tags for that, as it makes
them visually better and hightlights them.
While here, modify a few ones to make them clearer.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst b/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst index 96b6eaca755c..39e24ad4b825 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst +++ b/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst @@ -125,10 +125,12 @@ still cause this situation. the payload. If :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` finds that this value is less than is required to store the payload result, then it is set to a value large enough to store the payload result and ``ENOSPC`` is - returned. Note that for string controls this ``size`` field should - not be confused with the length of the string. This field refers - to the size of the memory that contains the string. The actual - *length* of the string may well be much smaller. + returned. + + .. note:: For string controls, this ``size`` field should + not be confused with the length of the string. This field refers + to the size of the memory that contains the string. The actual + *length* of the string may well be much smaller. - .. row 3 @@ -261,8 +263,10 @@ still cause this situation. - Which value of the control to get/set/try. ``V4L2_CTRL_WHICH_CUR_VAL`` will return the current value of the control and ``V4L2_CTRL_WHICH_DEF_VAL`` will return the default - value of the control. Please note that you can only get the - default value of the control, you cannot set or try it. + value of the control. + + .. note:: You can only get the default value of the control, + you cannot set or try it. For backwards compatibility you can also use a control class here (see :ref:`ctrl-class`). In that case all controls have to |