linux/Documentation/media/uapi/v4l/v4l2-selection-flags.rst
Laurent Pinchart c2b66cafdf [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>
2016-09-22 07:03:14 -03:00

45 lines
1.3 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _v4l2-selection-flags:
***************
Selection flags
***************
.. tabularcolumns:: |p{5.2cm}|p{2.0cm}|p{6.5cm}|p{1.2cm}|p{1.6cm}|
.. _v4l2-selection-flags-table:
.. flat-table:: Selection flag definitions
:header-rows: 1
:stub-columns: 0
* - Flag name
- id
- Definition
- Valid for V4L2
- Valid for V4L2 subdev
* - ``V4L2_SEL_FLAG_GE``
- (1 << 0)
- Suggest the driver it should choose greater or equal rectangle (in
size) than was requested. Albeit the driver may choose a lesser
size, it will only do so due to hardware limitations. Without this
flag (and ``V4L2_SEL_FLAG_LE``) the behaviour is to choose the
closest possible rectangle.
- Yes
- Yes
* - ``V4L2_SEL_FLAG_LE``
- (1 << 1)
- Suggest the driver it should choose lesser or equal rectangle (in
size) than was requested. Albeit the driver may choose a greater
size, it will only do so due to hardware limitations.
- Yes
- Yes
* - ``V4L2_SEL_FLAG_KEEP_CONFIG``
- (1 << 2)
- The configuration must not be propagated to any further processing
steps. If this flag is not given, the configuration is propagated
inside the subdevice to all further processing steps.
- No
- Yes