diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-29 22:37:59 +0200 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 14:34:01 +0200 |
commit | e8be7e97e639af6f968473e5a598afbebc737b9c (patch) | |
tree | a33c38e32956ad127634eabb978f824ecbbb6c65 /Documentation/media/uapi/v4l/vidioc-queryctrl.rst | |
parent | [media] v4l2-ctrls: document some extra data structures (diff) | |
download | linux-e8be7e97e639af6f968473e5a598afbebc737b9c.tar.xz linux-e8be7e97e639af6f968473e5a598afbebc737b9c.zip |
[media] docs-rst: convert uAPI structs to C domain
instead of declaring the uAPI structs using usual refs, e. g.:
.. _foo-struct:
Use the C domain way:
.. c:type:: foo_struct
This way, the kAPI documentation can use cross-references to
point to the uAPI symbols.
That solves about ~100 undefined warnings like:
WARNING: c:type reference target not found: foo_struct
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-queryctrl.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/vidioc-queryctrl.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst index db3ad928ec1c..ef32e28e57c7 100644 --- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst +++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst @@ -592,7 +592,7 @@ See also the examples in :ref:`control`. pass a string of length 8 to :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you need to set the ``size`` field of struct - :ref:`v4l2_ext_control <v4l2-ext-control>` to 9. For + :c:type:`v4l2_ext_control` to 9. For :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you can set the ``size`` field to ``maximum`` + 1. Which character encoding is used will depend on the string control itself and should be part @@ -769,7 +769,7 @@ See also the examples in :ref:`control`. - This control has a pointer type, so its value has to be accessed using one of the pointer fields of struct - :ref:`v4l2_ext_control <v4l2-ext-control>`. This flag is set + :c:type:`v4l2_ext_control`. This flag is set for controls that are an array, string, or have a compound type. In all cases you have to set a pointer to memory containing the payload of the control. |