diff options
author | Hans Verkuil <hverkuil-cisco@xs4all.nl> | 2020-02-10 11:42:38 +0100 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-02-24 17:52:44 +0100 |
commit | 218fc9f2fcfbad70e7b2111eca591b1dc8e6c8a9 (patch) | |
tree | e93987baba2ac953bc08cfa8be1b86f7ca57bfef /Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst | |
parent | f86a183cda8798899ffc33031f17afd788b1ec90 (diff) |
media: Documentation/media/uapi: more readable unions
Avoid adding an extra columns when describing unions in the documentation.
That makes it much harder to read. See e.g. VIDIOC_QUERY_EXT_CTRLS.
Instead start off a union with 'union {' and end it with an extra row
containing '}'.
This leaves a lot more space for the description of the fields.
This formatting technique was used in a few places already, but this
patches fixes all remaining occurrences of 'union' in the media uAPI.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Reported-by: Nicolas Dufresne <nicolas@ndufresne.ca>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst b/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst index 5c675cbac4cf..e36dd2622857 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst +++ b/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst @@ -179,23 +179,21 @@ EBUSY .. flat-table:: struct v4l2_dv_timings :header-rows: 0 :stub-columns: 0 - :widths: 1 1 2 1 + :widths: 1 1 2 * - __u32 - ``type`` - - - Type of DV timings as listed in :ref:`dv-timing-types`. - * - union - - - - - * - - - struct :c:type:`v4l2_bt_timings` + * - union { + - (anonymous) + * - struct :c:type:`v4l2_bt_timings` - ``bt`` - Timings defined by BT.656/1120 specifications - * - - - __u32 + * - __u32 - ``reserved``\ [32] - + * - } + - .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| |