summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2016-09-05 08:44:34 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-22 07:03:14 -0300
commitc2b66cafdf020856f6981d03efd9f2706d5f0156 (patch)
tree53fc68378fd5a4205b0872ca16e4f3160da1fe45
parentc19584882a435bbe41fa555620c7261ba9155ae2 (diff)
[media] v4l: doc: Remove row numbers from tables
Shorten the tables by removing row numbers in comments, allowing for later insertion of rows with minimal diffs. All changes have been generated by the following script. import io import re import sys def process_table(fname, data): if fname.endswith('hist-v4l2.rst'): data = re.sub(u'\n{1,2}\t( ?) -( ?) ?', u'\n\t\\1 -\\2', data, flags = re.MULTILINE) data = re.sub(u'\n(\t| )- \.\. row [0-9]+\n\t ?-( ?) ?', u'\\1* -\\2', data, flags = re.MULTILINE) else: data = re.sub(u'\n{1,2} -( ?) ?', u'\n -\\1', data, flags = re.MULTILINE) data = re.sub(u'(\n?)(\n\n - \.\. row 1\n)', u'\n\\2', data, flags = re.MULTILINE) data = re.sub(u'\n - \.\. row [0-9]+\n -( ?) ?', u' * -\\1', data, flags = re.MULTILINE) data = re.sub(u'\n - \.\. row [0-9]+\n \.\. (_[A-Z0-9_`-]*:)', u'\n - .. \\1', data, flags = re.MULTILINE) data = re.sub(u'\n - \.\. (_[A-Z0-9_`-]*:)\n -', u' * .. \\1\n\n -', data, flags = re.MULTILINE) data = re.sub(u'^ - ', u' -', data, flags = re.MULTILINE) data = re.sub(u'^(\t{1,2}) ', u'\\1', data, flags = re.MULTILINE) return data def process_file(fname, data): buf = io.StringIO(data) output = '' in_table = False table_separator = 0 for line in buf.readlines(): if line.find('.. flat-table::') != -1: in_table = True table = '' elif in_table and not re.match('^[\t\n]|( )', line): in_table = False output += process_table(fname, table) if in_table: table += line else: output += line if in_table: in_table = False output += process_table(fname, table) return output fname = sys.argv[1] data = file(fname, 'rb').read().decode('utf-8') data = process_file(fname, data) file(fname, 'wb').write(data.encode('utf-8')) Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
-rw-r--r--Documentation/media/uapi/v4l/buffer.rst1337
-rw-r--r--Documentation/media/uapi/v4l/control.rst133
-rw-r--r--Documentation/media/uapi/v4l/dev-raw-vbi.rst243
-rw-r--r--Documentation/media/uapi/v4l/dev-rds.rst191
-rw-r--r--Documentation/media/uapi/v4l/dev-sdr.rst43
-rw-r--r--Documentation/media/uapi/v4l/dev-sliced-vbi.rst730
-rw-r--r--Documentation/media/uapi/v4l/dev-subdev.rst114
-rw-r--r--Documentation/media/uapi/v4l/diff-v4l.rst676
-rw-r--r--Documentation/media/uapi/v4l/extended-controls.rst2753
-rw-r--r--Documentation/media/uapi/v4l/field-order.rst188
-rw-r--r--Documentation/media/uapi/v4l/hist-v4l2.rst231
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-002.rst298
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-003.rst195
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-006.rst306
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-007.rst495
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-013.rst186
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-grey.rst68
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-indexed.rst82
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-m420.rst249
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-nv12.rst248
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-nv12m.rst255
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-nv16.rst320
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-nv16m.rst325
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-nv24.rst183
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-packed-rgb.rst2134
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-packed-yuv.rst439
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-reserved.rst539
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-sbggr16.rst115
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-sdr-cs08.rst16
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-sdr-cs14le.rst21
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-sdr-cu08.rst15
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-sdr-cu16le.rst21
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-sdr-ru12le.rst11
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-srggb10.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-srggb10p.rst87
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-srggb12.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-srggb8.rst68
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-tch-td08.rst68
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-tch-td16.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-tch-tu08.rst68
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-tch-tu16.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-uv8.rst68
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-uyvy.rst228
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-vyuy.rst228
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y10.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y10b.rst16
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y12.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y12i.rst11
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y16-be.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y16.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y41p.rst336
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-y8i.rst116
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv410.rst228
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv411p.rst230
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv420.rst273
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv420m.rst283
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv422m.rst278
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv422p.rst268
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuv444m.rst298
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yuyv.rst238
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-yvyu.rst228
-rw-r--r--Documentation/media/uapi/v4l/pixfmt-z16.rst116
-rw-r--r--Documentation/media/uapi/v4l/subdev-formats.rst18062
-rw-r--r--Documentation/media/uapi/v4l/v4l2-selection-flags.rst84
-rw-r--r--Documentation/media/uapi/v4l/v4l2-selection-targets.rst171
-rw-r--r--Documentation/media/uapi/v4l/vidioc-create-bufs.rst73
-rw-r--r--Documentation/media/uapi/v4l/vidioc-cropcap.rst128
-rw-r--r--Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst123
-rw-r--r--Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst117
-rw-r--r--Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst292
-rw-r--r--Documentation/media/uapi/v4l/vidioc-dqevent.rst668
-rw-r--r--Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst233
-rw-r--r--Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst134
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst50
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enum-fmt.rst142
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst184
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst213
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst187
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enuminput.rst437
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enumoutput.rst208
-rw-r--r--Documentation/media/uapi/v4l/vidioc-enumstd.rst292
-rw-r--r--Documentation/media/uapi/v4l/vidioc-expbuf.rst90
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-audio.rst102
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-audioout.rst65
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-crop.rst30
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-ctrl.rst22
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst465
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-edid.rst73
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-enc-index.rst167
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst538
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-fbuf.rst593
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-fmt.rst128
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-frequency.rst74
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst144
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-modulator.rst268
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-parm.rst372
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-priority.rst73
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-selection.rst63
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst312
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-tuner.rst897
-rw-r--r--Documentation/media/uapi/v4l/vidioc-querycap.rst555
-rw-r--r--Documentation/media/uapi/v4l/vidioc-queryctrl.rst975
-rw-r--r--Documentation/media/uapi/v4l/vidioc-reqbufs.rst54
-rw-r--r--Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst132
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst94
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst105
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst61
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst48
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst72
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst35
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst70
-rw-r--r--Documentation/media/uapi/v4l/vidioc-subscribe-event.rst120
112 files changed, 15395 insertions, 31022 deletions
diff --git a/Documentation/media/uapi/v4l/buffer.rst b/Documentation/media/uapi/v4l/buffer.rst
index 21893ee1384a..ac58966ccb9b 100644
--- a/Documentation/media/uapi/v4l/buffer.rst
+++ b/Documentation/media/uapi/v4l/buffer.rst
@@ -48,236 +48,149 @@ struct v4l2_buffer
:stub-columns: 0
:widths: 1 2 1 10
-
- - .. row 1
-
- - __u32
-
- - ``index``
-
- -
- - Number of the buffer, set by the application except when calling
- :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, then it is set by the
- driver. This field can range from zero to the number of buffers
- allocated with the :ref:`VIDIOC_REQBUFS` ioctl
- (struct :c:type:`v4l2_requestbuffers`
- ``count``), plus any buffers allocated with
- :ref:`VIDIOC_CREATE_BUFS` minus one.
-
- - .. row 2
-
- - __u32
-
- - ``type``
-
- -
- - Type of the buffer, same as struct
- :c:type:`v4l2_format` ``type`` or struct
- :c:type:`v4l2_requestbuffers` ``type``, set
- by the application. See :c:type:`v4l2_buf_type`
-
- - .. row 3
-
- - __u32
-
- - ``bytesused``
-
- -
- - The number of bytes occupied by the data in the buffer. It depends
- on the negotiated data format and may change with each buffer for
- compressed variable size data like JPEG images. Drivers must set
- this field when ``type`` refers to a capture stream, applications
- when it refers to an output stream. If the application sets this
- to 0 for an output stream, then ``bytesused`` will be set to the
- size of the buffer (see the ``length`` field of this struct) by
- the driver. For multiplanar formats this field is ignored and the
- ``planes`` pointer is used instead.
-
- - .. row 4
-
- - __u32
-
- - ``flags``
-
- -
- - Flags set by the application or driver, see :ref:`buffer-flags`.
-
- - .. row 5
-
- - __u32
-
- - ``field``
-
- -
- - Indicates the field order of the image in the buffer, see
- :c:type:`v4l2_field`. This field is not used when the buffer
- contains VBI data. Drivers must set it when ``type`` refers to a
- capture stream, applications when it refers to an output stream.
-
- - .. row 6
-
- - struct timeval
-
- - ``timestamp``
-
- -
- - For capture streams this is time when the first data byte was
- captured, as returned by the :c:func:`clock_gettime()` function
- for the relevant clock