diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-08 05:43:01 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 09:54:54 -0300 |
commit | fc78c7c7a1747912293ad9f78374f5be7f0acc6d (patch) | |
tree | 63d49d34bf467602f74f7b8f3449ebcbf22f58fe /Documentation/media/uapi/v4l/vidioc-g-fmt.rst | |
parent | 2606eee43cbceb1356ddb11a5f3cc9a89a0cec66 (diff) | |
download | op-kernel-dev-fc78c7c7a1747912293ad9f78374f5be7f0acc6d.zip op-kernel-dev-fc78c7c7a1747912293ad9f78374f5be7f0acc6d.tar.gz |
[media] docs-rst: simplify c:type: cross references
Instead of using c:type:`struct foo <foo>`, use:
struct c:type:`foo`
This patch was generated via this shell script:
for i in `find Documentation/media -type f`; do perl -ne 'if (m/\:c\:type\:\`struct\s+(\S+)\s*\<(\S+)\>\`/) { $s=$1; $r=$2; if ($s eq $r) { s/\:c\:type\:\`struct\s+(\S+)\s*\<(\S+)\>\`/struct :c:type:`$2`/; s/struct\s+struct/struct/; s/(struct\s+\:c\:type\:\`\S+\`)\s+structure/$1/; }} print $_' <$i >a && mv a $i; done
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-fmt.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/vidioc-g-fmt.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-fmt.rst b/Documentation/media/uapi/v4l/vidioc-g-fmt.rst index dd6c062..037437d 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-fmt.rst +++ b/Documentation/media/uapi/v4l/vidioc-g-fmt.rst @@ -40,7 +40,7 @@ These ioctls are used to negotiate the format of data (typically image format) exchanged between driver and application. To query the current parameters applications set the ``type`` field of a -struct :c:type:`struct v4l2_format <v4l2_format>` to the respective buffer (stream) +struct :c:type:`v4l2_format` to the respective buffer (stream) type. For example video capture devices use ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``. When the application calls the @@ -58,7 +58,7 @@ For details see the documentation of the various devices types in :ref:`devices`. Good practice is to query the current parameters first, and to modify only those parameters not suitable for the application. When the application calls the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with -a pointer to a :c:type:`struct v4l2_format <v4l2_format>` structure the driver +a pointer to a struct :c:type:`v4l2_format` structure the driver checks and adjusts the parameters against hardware abilities. Drivers should not return an error code unless the ``type`` field is invalid, this is a mechanism to fathom device capabilities and to approach |