* [PATCH 1/2] [media] doc-rst: use the right markup for footnotes
@ 2016-07-13 11:15 Mauro Carvalho Chehab
2016-07-13 11:15 ` [PATCH 2/2] [media] docs-rst: escape [] characters Mauro Carvalho Chehab
0 siblings, 1 reply; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-13 11:15 UTC (permalink / raw)
Cc: Mauro Carvalho Chehab, Linux Media Mailing List,
Mauro Carvalho Chehab, Jonathan Corbet, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 35010 bytes --]
According with ReST spec, footnotes should be like:
[#name], and not [name]. So, change them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/media/uapi/v4l/audio.rst | 4 +--
Documentation/media/uapi/v4l/control.rst | 4 +--
Documentation/media/uapi/v4l/dev-overlay.rst | 16 +++++-----
Documentation/media/uapi/v4l/dev-raw-vbi.rst | 18 +++++------
Documentation/media/uapi/v4l/dev-sliced-vbi.rst | 4 +--
Documentation/media/uapi/v4l/diff-v4l.rst | 36 +++++++++++-----------
Documentation/media/uapi/v4l/extended-controls.rst | 4 +--
Documentation/media/uapi/v4l/format.rst | 4 +--
Documentation/media/uapi/v4l/func-select.rst | 4 +--
Documentation/media/uapi/v4l/hist-v4l2.rst | 4 +--
Documentation/media/uapi/v4l/mmap.rst | 12 ++++----
Documentation/media/uapi/v4l/open.rst | 12 ++++----
Documentation/media/uapi/v4l/rw.rst | 8 ++---
Documentation/media/uapi/v4l/standard.rst | 4 +--
Documentation/media/uapi/v4l/userp.rst | 8 ++---
Documentation/media/uapi/v4l/vidioc-enumstd.rst | 26 ++++++++--------
Documentation/media/uapi/v4l/vidioc-g-fbuf.rst | 4 +--
Documentation/media/uapi/v4l/vidioc-g-tuner.rst | 8 ++---
Documentation/media/uapi/v4l/vidioc-querycap.rst | 4 +--
Documentation/media/uapi/v4l/vidioc-queryctrl.rst | 4 +--
20 files changed, 94 insertions(+), 94 deletions(-)
diff --git a/Documentation/media/uapi/v4l/audio.rst b/Documentation/media/uapi/v4l/audio.rst
index cd3057326de7..4dd11345866c 100644
--- a/Documentation/media/uapi/v4l/audio.rst
+++ b/Documentation/media/uapi/v4l/audio.rst
@@ -11,7 +11,7 @@ capture devices have inputs, output devices have outputs, zero or more
each. Radio devices have no audio inputs or outputs. They have exactly
one tuner which in fact *is* an audio source, but this API associates
tuners with video inputs or outputs only, and radio devices have none of
-these. [1]_ A connector on a TV card to loop back the received audio
+these. [#f1]_ A connector on a TV card to loop back the received audio
signal to a sound card is not considered an audio output.
Audio and video inputs and outputs are associated. Selecting a video
@@ -88,7 +88,7 @@ Example: Switching to the first audio input
exit(EXIT_FAILURE);
}
-.. [1]
+.. [#f1]
Actually struct :ref:`v4l2_audio <v4l2-audio>` ought to have a
``tuner`` field like struct :ref:`v4l2_input <v4l2-input>`, not
only making the API more consistent but also permitting radio devices
diff --git a/Documentation/media/uapi/v4l/control.rst b/Documentation/media/uapi/v4l/control.rst
index feb55ac14377..10ab53dd3163 100644
--- a/Documentation/media/uapi/v4l/control.rst
+++ b/Documentation/media/uapi/v4l/control.rst
@@ -17,7 +17,7 @@ device.
All controls are accessed using an ID value. V4L2 defines several IDs
for specific purposes. Drivers can also implement their own custom
-controls using ``V4L2_CID_PRIVATE_BASE`` [1]_ and higher values. The
+controls using ``V4L2_CID_PRIVATE_BASE`` [#f1]_ and higher values. The
pre-defined control IDs have the prefix ``V4L2_CID_``, and are listed in
:ref:`control-id`. The ID is used when querying the attributes of a
control, and when getting or setting the current value.
@@ -522,7 +522,7 @@ Example: Changing controls
/* Errors ignored */
ioctl(fd, VIDIOC_S_CTRL, &control);
-.. [1]
+.. [#f1]
The use of ``V4L2_CID_PRIVATE_BASE`` is problematic because different
drivers may use the same ``V4L2_CID_PRIVATE_BASE`` ID for different
controls. This makes it hard to programatically set such controls
diff --git a/Documentation/media/uapi/v4l/dev-overlay.rst b/Documentation/media/uapi/v4l/dev-overlay.rst
index bf8a418e7554..3edb53bfaa27 100644
--- a/Documentation/media/uapi/v4l/dev-overlay.rst
+++ b/Documentation/media/uapi/v4l/dev-overlay.rst
@@ -33,7 +33,7 @@ Applications should use different file descriptors for capturing and
overlay. This must be supported by all drivers capable of simultaneous
capturing and overlay. Optionally these drivers may also permit
capturing and overlay with a single file descriptor for compatibility
-with V4L and earlier versions of V4L2. [1]_
+with V4L and earlier versions of V4L2. [#f1]_
Querying Capabilities
@@ -216,7 +216,7 @@ bits like:
((__u8 *) bitmap)[w.width * y + x / 8] & (1 << (x & 7))
-where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [2]_
+where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [#f2]_
When a clipping bit mask is not supported the driver ignores this field,
its contents after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are
@@ -227,7 +227,7 @@ Applications need not create a clip list or bit mask. When they pass
both, or despite negotiating chroma-keying, the results are undefined.
Regardless of the chosen method, the clipping abilities of the hardware
may be limited in quantity or quality. The results when these limits are
-exceeded are undefined. [3]_
+exceeded are undefined. [#f3]_
``__u8 global_alpha``
The global alpha value used to blend the framebuffer with video
@@ -244,7 +244,7 @@ exceeded are undefined. [3]_
.. _v4l2-clip:
-struct v4l2_clip [4]_
+struct v4l2_clip [#f4]_
---------------------
``struct v4l2_rect c``
@@ -284,7 +284,7 @@ Enabling Overlay
To start or stop the frame buffer overlay applications call the
:ref:`VIDIOC_OVERLAY` ioctl.
-.. [1]
+.. [#f1]
A common application of two file descriptors is the XFree86
:ref:`Xv/V4L <xvideo>` interface driver and a V4L2 application.
While the X server controls video overlay, the application can take
@@ -301,17 +301,17 @@ To start or stop the frame buffer overlay applications call the
Hence as a complexity trade-off drivers *must* support two file
descriptors and *may* support single fd operation.
-.. [2]
+.. [#f2]
Should we require ``w.width`` to be a multiple of eight?
-.. [3]
+.. [#f3]
When the image is written into frame buffer memory it will be
undesirable if the driver clips out less pixels than expected,
because the application and graphics system are not aware these
regions need to be refreshed. The driver should clip out more pixels
or not write the image at all.
-.. [4]
+.. [#f4]
The X Window system defines "regions" which are vectors of ``struct
BoxRec { short x1, y1, x2, y2; }`` with ``width = x2 - x1`` and
``height = y2 - y1``, so one cannot pass X11 clip lists directly.
diff --git a/Documentation/media/uapi/v4l/dev-raw-vbi.rst b/Documentation/media/uapi/v4l/dev-raw-vbi.rst
index da85be88d57e..d5a4b3530b69 100644
--- a/Documentation/media/uapi/v4l/dev-raw-vbi.rst
+++ b/Documentation/media/uapi/v4l/dev-raw-vbi.rst
@@ -11,7 +11,7 @@ sequence of lines of an analog video signal. During VBI no picture
information is transmitted, allowing some time while the electron beam
of a cathode ray tube TV returns to the top of the screen. Using an
oscilloscope you will find here the vertical synchronization pulses and
-short data packages ASK modulated [1]_ onto the video signal. These are
+short data packages ASK modulated [#f1]_ onto the video signal. These are
transmissions of services such as Teletext or Closed Caption.
Subject of this interface type is raw VBI data, as sampled off a video
@@ -143,7 +143,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
- ``sample_format``
- Defines the sample format as in :ref:`pixfmt`, a
- four-character-code. [2]_ Usually this is ``V4L2_PIX_FMT_GREY``,
+ four-character-code. [#f2]_ Usually this is ``V4L2_PIX_FMT_GREY``,
i. e. each sample consists of 8 bits with lower values oriented
towards the black level. Do not assume any other correlation of
values with the signal level. For example, the MSB does not
@@ -155,7 +155,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
- __u32
- - ``start``\ [2]_
+ - ``start``\ [#f2]_
- This is the scanning system line number associated with the first
line of the VBI image, of the first and the second field
@@ -173,7 +173,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
- __u32
- - ``count``\ [2]_
+ - ``count``\ [#f2]_
- The number of lines in the first and second field image,
respectively.
@@ -218,7 +218,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
- __u32
- - ``reserved``\ [2]_
+ - ``reserved``\ [#f2]_
- This array is reserved for future extensions. Drivers and
applications must set it to zero.
@@ -245,7 +245,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
or bottom field depending on the video standard. When this flag is
set the first or second field may be stored first, however the
fields are still in correct temporal order with the older field
- first in memory. [3]_
+ first in memory. [#f3]_
- .. row 2
@@ -336,15 +336,15 @@ points returning an ``EBUSY`` error code if the required hardware resources
are temporarily unavailable, for example the device is already in use by
another process.
-.. [1]
+.. [#f1]
ASK: Amplitude-Shift Keying. A high signal level represents a '1'
bit, a low level a '0' bit.
-.. [2]
+.. [#f2]
A few devices may be unable to sample VBI data at all but can extend
the video capture window to the VBI region.
-.. [3]
+.. [#f3]
Most VBI services transmit on both fields, but some have different
semantics depending on the field number. These cannot be reliable
decoded or encoded when ``V4L2_VBI_UNSYNC`` is set.
diff --git a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst b/Documentation/media/uapi/v4l/dev-sliced-vbi.rst
index fbd04fee0484..ec52a825f4d6 100644
--- a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst
+++ b/Documentation/media/uapi/v4l/dev-sliced-vbi.rst
@@ -126,7 +126,7 @@ struct v4l2_sliced_vbi_format
specified in this field. For example, if ``service_set`` is
initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``,
a driver for the cx25840 video decoder sets lines 7-22 of both
- fields [1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first
+ fields [#f1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first
field to ``V4L2_SLICED_WSS_625``. If ``service_set`` is set to
zero, then the values of ``service_lines`` will be used instead.
@@ -817,6 +817,6 @@ Line Identifiers for struct v4l2_mpeg_vbi_itv0_line id field
-.. [1]
+.. [#f1]
According to :ref:`ETS 300 706 <ets300706>` lines 6-22 of the first
field and lines 5-22 of the second field may carry Teletext data.
diff --git a/Documentation/media/uapi/v4l/diff-v4l.rst b/Documentation/media/uapi/v4l/diff-v4l.rst
index 5f45ec123162..e1e034df514c 100644
--- a/Documentation/media/uapi/v4l/diff-v4l.rst
+++ b/Documentation/media/uapi/v4l/diff-v4l.rst
@@ -52,7 +52,7 @@ using driver module options. The major device number remains 81.
- Video capture and overlay
- - ``/dev/video`` and ``/dev/bttv0``\ [1]_, ``/dev/video0`` to
+ - ``/dev/video`` and ``/dev/bttv0``\ [#f1]_, ``/dev/video0`` to
``/dev/video63``
- 0-63
@@ -61,7 +61,7 @@ using driver module options. The major device number remains 81.
- Radio receiver
- - ``/dev/radio``\ [2]_, ``/dev/radio0`` to ``/dev/radio63``
+ - ``/dev/radio``\ [#f2]_, ``/dev/radio0`` to ``/dev/radio63``
- 64-127
@@ -457,7 +457,7 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`:
- ``VIDEO_PALETTE_HI240``
- - :ref:`V4L2_PIX_FMT_HI240 <pixfmt-reserved>` [3]_
+ - :ref:`V4L2_PIX_FMT_HI240 <pixfmt-reserved>` [#f3]_
- .. row 4
@@ -481,7 +481,7 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`:
- ``VIDEO_PALETTE_RGB32``
- - :ref:`V4L2_PIX_FMT_BGR32 <pixfmt-rgb>` [4]_
+ - :ref:`V4L2_PIX_FMT_BGR32 <pixfmt-rgb>` [#f4]_
- .. row 8
@@ -491,7 +491,7 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`:
- .. row 9
- - ``VIDEO_PALETTE_YUYV``\ [5]_
+ - ``VIDEO_PALETTE_YUYV``\ [#f5]_
- :ref:`V4L2_PIX_FMT_YUYV <V4L2-PIX-FMT-YUYV>`
@@ -511,13 +511,13 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`:
- ``VIDEO_PALETTE_YUV411``
- - :ref:`V4L2_PIX_FMT_Y41P <V4L2-PIX-FMT-Y41P>` [6]_
+ - :ref:`V4L2_PIX_FMT_Y41P <V4L2-PIX-FMT-Y41P>` [#f6]_
- .. row 13
- ``VIDEO_PALETTE_RAW``
- - None [7]_
+ - None [#f7]_
- .. row 14
@@ -529,7 +529,7 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`:
- ``VIDEO_PALETTE_YUV411P``
- - :ref:`V4L2_PIX_FMT_YUV411P <V4L2-PIX-FMT-YUV411P>` [8]_
+ - :ref:`V4L2_PIX_FMT_YUV411P <V4L2-PIX-FMT-YUV411P>` [#f8]_
- .. row 16
@@ -876,7 +876,7 @@ with the following parameters:
- count[]
- - 16, 16 [9]_
+ - 16, 16 [#f9]_
- .. row 8
@@ -915,40 +915,40 @@ No replacement exists for ``VIDIOCKEY``, and the V4L functions for
microcode programming. A new interface for MPEG compression and playback
devices is documented in :ref:`extended-controls`.
-.. [1]
+.. [#f1]
According to Documentation/devices.txt these should be symbolic links
to ``/dev/video0``. Note the original bttv interface is not
compatible with V4L or V4L2.
-.. [2]
+.. [#f2]
According to ``Documentation/devices.txt`` a symbolic link to
``/dev/radio0``.
-.. [3]
+.. [#f3]
This is a custom format used by the BTTV driver, not one of the V4L2
standard formats.
-.. [4]
+.. [#f4]
Presumably all V4L RGB formats are little-endian, although some
drivers might interpret them according to machine endianness. V4L2
defines little-endian, big-endian and red/blue swapped variants. For
details see :ref:`pixfmt-rgb`.
-.. [5]
+.. [#f5]
``VIDEO_PALETTE_YUV422`` and ``VIDEO_PALETTE_YUYV`` are the same
formats. Some V4L drivers respond to one, some to the other.
-.. [6]
+.. [#f6]
Not to be confused with ``V4L2_PIX_FMT_YUV411P``, which is a planar
format.
-.. [7]
+.. [#f7]
V4L explains this as: "RAW capture (BT848)"
-.. [8]
+.. [#f8]
Not to be confused with ``V4L2_PIX_FMT_Y41P``, which is a packed
format.
-.. [9]
+.. [#f9]
Old driver versions used different values, eventually the custom
``BTTV_VBISIZE`` ioctl was added to query the correct values.
diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/media/uapi/v4l/extended-controls.rst
index 11d15d3190e9..71071d73747d 100644
--- a/Documentation/media/uapi/v4l/extended-controls.rst
+++ b/Documentation/media/uapi/v4l/extended-controls.rst
@@ -3183,7 +3183,7 @@ Camera Control IDs
of the illumination varies significantly throughout the scene, i.e.
there are simultaneously very dark and very bright areas. It is most
commonly realized in cameras by combining two subsequent frames with
- different exposure times. [1]_
+ different exposure times. [#f1]_
.. _v4l2-image-stabilization:
@@ -4526,6 +4526,6 @@ RF_TUNER Control IDs
Is synthesizer PLL locked? RF tuner is receiving given frequency
when that control is set. This is a read-only control.
-.. [1]
+.. [#f1]
This control may be changed to a menu control in the future, if more
options are required.
diff --git a/Documentation/media/uapi/v4l/format.rst b/Documentation/media/uapi/v4l/format.rst
index a29dd9466b8f..7c73278849ca 100644
--- a/Documentation/media/uapi/v4l/format.rst
+++ b/Documentation/media/uapi/v4l/format.rst
@@ -73,7 +73,7 @@ Image Format Enumeration
Apart of the generic format negotiation functions a special ioctl to
enumerate all image formats supported by video capture, overlay or
-output devices is available. [1]_
+output devices is available. [#f1]_
The :ref:`VIDIOC_ENUM_FMT` ioctl must be supported
by all drivers exchanging image data with applications.
@@ -85,7 +85,7 @@ by all drivers exchanging image data with applications.
If necessary driver writers should publish an example conversion
routine or library for integration into applications.
-.. [1]
+.. [#f1]
Enumerating formats an application has no a-priori knowledge of
(otherwise it could explicitly ask for them and need not enumerate)
seems useless, but there are applications serving as proxy between
diff --git a/Documentation/media/uapi/v4l/func-select.rst b/Documentation/media/uapi/v4l/func-select.rst
index 954dd00b8301..7798384ae396 100644
--- a/Documentation/media/uapi/v4l/func-select.rst
+++ b/Documentation/media/uapi/v4l/func-select.rst
@@ -50,7 +50,7 @@ set appropriately. When the application did not call
:ref:`VIDIOC_STREAMON` yet the :ref:`select() <func-select>`
function succeeds, setting the bit of the file descriptor in ``readfds``
or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`
-calls will fail. [1]_
+calls will fail. [#f1]_
When use of the :ref:`read() <func-read>` function has been negotiated and the
driver does not capture yet, the :ref:`select() <func-select>` function starts
@@ -100,7 +100,7 @@ EINVAL
The ``nfds`` argument is less than zero or greater than
``FD_SETSIZE``.
-.. [1]
+.. [#f1]
The Linux kernel implements :ref:`select() <func-select>` like the
:ref:`poll() <func-poll>` function, but :ref:`select() <func-select>` cannot
return a ``POLLERR``.
diff --git a/Documentation/media/uapi/v4l/hist-v4l2.rst b/Documentation/media/uapi/v4l/hist-v4l2.rst
index a571e099fde7..3ba1c0c2df1a 100644
--- a/Documentation/media/uapi/v4l/hist-v4l2.rst
+++ b/Documentation/media/uapi/v4l/hist-v4l2.rst
@@ -1391,7 +1391,7 @@ the X Window system, implemented for example by the XFree86 project. Its
scope is similar to V4L2, an API to video capture and output devices for
X clients. Xv allows applications to display live video in a window,
send window contents to a TV output, and capture or output still images
-in XPixmaps [1]_. With their implementation XFree86 makes the extension
+in XPixmaps [#f1]_. With their implementation XFree86 makes the extension
available across many operating systems and architectures.
Because the driver is embedded into the X server Xv has a number of
@@ -1476,5 +1476,5 @@ should not be implemented in new drivers.
``VIDIOC_SUBDEV_G_SELECTION`` and ``VIDIOC_SUBDEV_S_SELECTION``,
:ref:`VIDIOC_SUBDEV_G_SELECTION`.
-.. [1]
+.. [#f1]
This is not implemented in XFree86.
diff --git a/Documentation/media/uapi/v4l/mmap.rst b/Documentation/media/uapi/v4l/mmap.rst
index 260c2db8916b..7ad5d5e76163 100644
--- a/Documentation/media/uapi/v4l/mmap.rst
+++ b/Documentation/media/uapi/v4l/mmap.rst
@@ -26,7 +26,7 @@ memory.
A driver can support many sets of buffers. Each set is identified by a
unique buffer type value. The sets are independent and each set can hold
a different type of data. To access different sets at the same time
-different file descriptors must be used. [1]_
+different file descriptors must be used. [#f1]_
To allocate device buffers applications call the
:ref:`VIDIOC_REQBUFS` ioctl with the desired number
@@ -217,7 +217,7 @@ The driver may require a minimum number of buffers enqueued at all times
to function, apart of this no limit exists on the number of buffers
applications can enqueue in advance, or dequeue and process. They can
also enqueue in a different order than buffers have been dequeued, and
-the driver can *fill* enqueued *empty* buffers in any order. [2]_ The
+the driver can *fill* enqueued *empty* buffers in any order. [#f2]_ The
index number of a buffer (struct :ref:`v4l2_buffer <v4l2-buffer>`
``index``) plays no role here, it only identifies the buffer.
@@ -260,11 +260,11 @@ Drivers implementing memory mapping I/O must support the
<VIDIOC_QBUF>`, :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls, the :ref:`mmap()
<func-mmap>`, :ref:`munmap() <func-munmap>`, :ref:`select()
-<func-select>` and :ref:`poll() <func-poll>` function. [3]_
+<func-select>` and :ref:`poll() <func-poll>` function. [#f3]_
[capture example]
-.. [1]
+.. [#f1]
One could use one file descriptor and set the buffer type field
accordingly when calling :ref:`VIDIOC_QBUF` etc.,
but it makes the :ref:`select() <func-select>` function ambiguous. We also
@@ -272,14 +272,14 @@ and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls, the :ref:`mmap()
Video overlay for example is also a logical stream, although the CPU
is not needed for continuous operation.
-.. [2]
+.. [#f2]
Random enqueue order permits applications processing images out of
order (such as video codecs) to return buffers earlier, reducing the
probability of data loss. Random fill order allows drivers to reuse
buffers on a LIFO-basis, taking advantage of caches holding
scatter-gather lists and the like.
-.. [3]
+.. [#f3]
At the driver level :ref:`select() <func-select>` and :ref:`poll() <func-poll>` are
the same, and :ref:`select() <func-select>` is too important to be optional.
The rest should be evident.
diff --git a/Documentation/media/uapi/v4l/open.rst b/Documentation/media/uapi/v4l/open.rst
index a3e39df91e9d..afd116edb40d 100644
--- a/Documentation/media/uapi/v4l/open.rst
+++ b/Documentation/media/uapi/v4l/open.rst
@@ -99,12 +99,12 @@ linux-media mailing list:
Multiple Opens
==============
-V4L2 devices can be opened more than once. [1]_ When this is supported
+V4L2 devices can be opened more than once. [#f1]_ When this is supported
by the driver, users can for example start a "panel" application to
change controls like brightness or audio volume, while another
application captures video and audio. In other words, panel applications
are comparable to an ALSA audio mixer application. Just opening a V4L2
-device should not change the state of the device. [2]_
+device should not change the state of the device. [#f2]_
Once an application has allocated the memory buffers needed for
streaming data (by calling the :ref:`VIDIOC_REQBUFS`
@@ -117,7 +117,7 @@ that would affect the buffer sizes (e.g. by calling the
no longer allowed to allocate buffers or start or stop streaming. The
EBUSY error code will be returned instead.
-Merely opening a V4L2 device does not grant exclusive access. [3]_
+Merely opening a V4L2 device does not grant exclusive access. [#f3]_
Initiating data exchange however assigns the right to read or write the
requested type of data, and to change related properties, to this file
descriptor. Applications can request additional access privileges using
@@ -142,17 +142,17 @@ respectively. Devices are programmed using the
:ref:`ioctl() <func-ioctl>` function as explained in the following
sections.
-.. [1]
+.. [#f1]
There are still some old and obscure drivers that have not been
updated to allow for multiple opens. This implies that for such
drivers :ref:`open() <func-open>` can return an ``EBUSY`` error code
when the device is already in use.
-.. [2]
+.. [#f2]
Unfortunately, opening a radio device often switches the state of the
device to radio mode in many drivers. This behavior should be fixed
eventually as it violates the V4L2 specification.
-.. [3]
+.. [#f3]
Drivers could recognize the ``O_EXCL`` open flag. Presently this is
not required, so applications cannot know if it really works.
diff --git a/Documentation/media/uapi/v4l/rw.rst b/Documentation/media/uapi/v4l/rw.rst
index 66ba54648c45..dcac379c484f 100644
--- a/Documentation/media/uapi/v4l/rw.rst
+++ b/Documentation/media/uapi/v4l/rw.rst
@@ -31,17 +31,17 @@ vidctrl tool is fictitious):
To read from the device applications use the :ref:`read() <func-read>`
function, to write the :ref:`write() <func-write>` function. Drivers
must implement one I/O method if they exchange data with applications,
-but it need not be this. [1]_ When reading or writing is supported, the
+but it need not be this. [#f1]_ When reading or writing is supported, the
driver must also support the :ref:`select() <func-select>` and
-:ref:`poll() <func-poll>` function. [2]_
+:ref:`poll() <func-poll>` function. [#f2]_
-.. [1]
+.. [#f1]
It would be desirable if applications could depend on drivers
supporting all I/O interfaces, but as much as the complex memory
mapping I/O can be inadequate for some devices we have no reason to
require this interface, which is most useful for simple applications
capturing still images.
-.. [2]
+.. [#f2]
At the driver level :ref:`select() <func-select>` and :ref:`poll() <func-poll>` are
the same, and :ref:`select() <func-select>` is too important to be optional.
diff --git a/Documentation/media/uapi/v4l/standard.rst b/Documentation/media/uapi/v4l/standard.rst
index 9c390c2a128a..c4f678f545ec 100644
--- a/Documentation/media/uapi/v4l/standard.rst
+++ b/Documentation/media/uapi/v4l/standard.rst
@@ -33,7 +33,7 @@ signals. The first enumerated standard is a set of B and G/PAL, switched
automatically depending on the selected radio frequency in UHF or VHF
band. Enumeration gives a "PAL-B/G" or "PAL-I" choice. Similar a
Composite input may collapse standards, enumerating "PAL-B/G/H/I",
-"NTSC-M" and "SECAM-D/K". [1]_
+"NTSC-M" and "SECAM-D/K". [#f1]_
To query and select the standard used by the current video input or
output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
@@ -177,7 +177,7 @@ Example: Selecting a new video standard
exit(EXIT_FAILURE);
}
-.. [1]
+.. [#f1]
Some users are already confused by technical terms PAL, NTSC and
SECAM. There is no point asking them to distinguish between B, G, D,
or K when the software or hardware can do that automatically.
diff --git a/Documentation/media/uapi/v4l/userp.rst b/Documentation/media/uapi/v4l/userp.rst
index 601963a33acb..1d8b14bd4cdc 100644
--- a/Documentation/media/uapi/v4l/userp.rst
+++ b/Documentation/media/uapi/v4l/userp.rst
@@ -54,7 +54,7 @@ driver swaps memory pages within physical memory to create a continuous
area of memory. This happens transparently to the application in the
virtual memory subsystem of the kernel. When buffer pages have been
swapped out to disk they are brought back and finally locked in physical
-memory for DMA. [1]_
+memory for DMA. [#f1]_
Filled or displayed buffers are dequeued with the
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The driver can unlock the
@@ -99,9 +99,9 @@ Drivers implementing user pointer I/O must support the
:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`,
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls, the
-:ref:`select() <func-select>` and :ref:`poll() <func-poll>` function. [2]_
+:ref:`select() <func-select>` and :ref:`poll() <func-poll>` function. [#f2]_
-.. [1]
+.. [#f1]
We expect that frequently used buffers are typically not swapped out.
Anyway, the process of swapping, locking or generating scatter-gather
lists may be time consuming. The delay can be masked by the depth of
@@ -113,7 +113,7 @@ and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls, the
disk. Output buffers must be saved on the incoming and outgoing queue
because an application may share them with other processes.
-.. [2]
+.. [#f2]
At the driver level :ref:`select() <func-select>` and :ref:`poll() <func-poll>` are
the same, and :ref:`select() <func-select>` is too important to be optional.
The rest should be evident.
diff --git a/Documentation/media/uapi/v4l/vidioc-enumstd.rst b/Documentation/media/uapi/v4l/vidioc-enumstd.rst
index ce911c81bd3d..6699b26cdeb4 100644
--- a/Documentation/media/uapi/v4l/vidioc-enumstd.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enumstd.rst
@@ -41,7 +41,7 @@ structure or return an ``EINVAL`` error code when the index is out of
bounds. To enumerate all standards applications shall begin at index
zero, incrementing by one until the driver returns ``EINVAL``. Drivers may
enumerate a different set of standards after switching the video input
-or output. [1]_
+or output. [#f1]_
.. _v4l2-standard:
@@ -278,11 +278,11 @@ support digital TV. See also the Linux DVB API at
- Characteristics
- - M/NTSC [2]_
+ - M/NTSC [#f2]_
- M/PAL
- - N/PAL [3]_
+ - N/PAL [#f3]_
- B, B1, G/PAL
@@ -369,7 +369,7 @@ support digital TV. See also the Linux DVB API at
- + 4.5
- - + 5.5 ± 0.001 [4]_ [5]_ [6]_ [7]_
+ - + 5.5 ± 0.001 [#f4]_ [#f5]_ [#f6]_ [#f7]_
- + 6.5 ± 0.001
@@ -383,7 +383,7 @@ support digital TV. See also the Linux DVB API at
- + 6.5
- - + 6.5 [8]_
+ - + 6.5 [#f8]_
Return Value
@@ -400,42 +400,42 @@ EINVAL
ENODATA
Standard video timings are not supported for this input or output.
-.. [1]
+.. [#f1]
The supported standards may overlap and we need an unambiguous set to
find the current standard returned by :ref:`VIDIOC_G_STD <VIDIOC_G_STD>`.
-.. [2]
+.. [#f2]
Japan uses a standard similar to M/NTSC (V4L2_STD_NTSC_M_JP).
-.. [3]
+.. [#f3]
The values in brackets apply to the combination N/PAL a.k.a.
N\ :sub:`C` used in Argentina (V4L2_STD_PAL_Nc).
-.. [4]
+.. [#f4]
In the Federal Republic of Germany, Austria, Italy, the Netherlands,
Slovakia and Switzerland a system of two sound carriers is used, the
frequency of the second carrier being 242.1875 kHz above the
frequency of the first sound carrier. For stereophonic sound
transmissions a similar system is used in Australia.
-.. [5]
+.. [#f5]
New Zealand uses a sound carrier displaced 5.4996 ± 0.0005 MHz from
the vision carrier.
-.. [6]
+.. [#f6]
In Denmark, Finland, New Zealand, Sweden and Spain a system of two
sound carriers is used. In Iceland, Norway and Poland the same system
is being introduced. The second carrier is 5.85 MHz above the vision
carrier and is DQPSK modulated with 728 kbit/s sound and data
multiplex. (NICAM system)
-.. [7]
+.. [#f7]
In the United Kingdom, a system of two sound carriers is used. The
second sound carrier is 6.552 MHz above the vision carrier and is
DQPSK modulated with a 728 kbit/s sound and data multiplex able to
carry two sound channels. (NICAM system)
-.. [8]
+.. [#f8]
In France, a digital carrier 5.85 MHz away from the vision carrier
may be used in addition to the main sound carrier. It is modulated in
differentially encoded QPSK with a 728 kbit/s sound and data
diff --git a/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst b/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
index ef4592c338ef..d182d9f5a50d 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
@@ -112,7 +112,7 @@ destructive video overlay.
-
- Physical base address of the framebuffer, that is the address of
- the pixel in the top left corner of the framebuffer. [1]_
+ the pixel in the top left corner of the framebuffer. [#f1]_
- .. row 4
@@ -492,7 +492,7 @@ EPERM
EINVAL
The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` parameters are unsuitable.
-.. [1]
+.. [#f1]
A physical base address may not suit all platforms. GK notes in
theory we should pass something like PCI device + memory region +
offset instead. If you encounter problems please discuss on the
diff --git a/Documentation/media/uapi/v4l/vidioc-g-tuner.rst b/Documentation/media/uapi/v4l/vidioc-g-tuner.rst
index c82085513bee..614db06b8b4b 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-tuner.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-tuner.rst
@@ -622,7 +622,7 @@ To change the radio frequency the
- ``LANG2 = SAP``
- - ``LANG1_LANG2``\ [1]_
+ - ``LANG1_LANG2``\ [#f1]_
- .. row 3
@@ -686,7 +686,7 @@ To change the radio frequency the
- Language 1
- - Lang1/Lang2 (deprecated [2]_) or Lang1/Lang1
+ - Lang1/Lang2 (deprecated [#f2]_) or Lang1/Lang1
- Language 1
@@ -706,11 +706,11 @@ EINVAL
The struct :ref:`v4l2_tuner <v4l2-tuner>` ``index`` is out of
bounds.
-.. [1]
+.. [#f1]
This mode has been added in Linux 2.6.17 and may not be supported by
older drivers.
-.. [2]
+.. [#f2]
Playback of both languages in ``MODE_STEREO`` is deprecated. In the
future drivers should produce only the primary language in this mode.
Applications should request ``MODE_LANG1_LANG2`` to record both
diff --git a/Documentation/media/uapi/v4l/vidioc-querycap.rst b/Documentation/media/uapi/v4l/vidioc-querycap.rst
index f0271f834ac1..b10fed313f99 100644
--- a/Documentation/media/uapi/v4l/vidioc-querycap.rst
+++ b/Documentation/media/uapi/v4l/vidioc-querycap.rst
@@ -301,7 +301,7 @@ specification the ioctl returns an ``EINVAL`` error code.
secondary function of video output devices and overlays an image
onto an outgoing video signal. When the driver sets this flag, it
must clear the ``V4L2_CAP_VIDEO_OVERLAY`` flag and vice
- versa. [1]_
+ versa. [#f1]_
- .. row 14
@@ -428,7 +428,7 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-.. [1]
+.. [#f1]
The struct :ref:`v4l2_framebuffer <v4l2-framebuffer>` lacks an
enum :ref:`v4l2_buf_type <v4l2-buf-type>` field, therefore the
type of overlay is implied by the driver capabilities.
diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
index 4342aceddd57..8d6e61a7284d 100644
--- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
+++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
@@ -53,7 +53,7 @@ returns ``EINVAL``.
In both cases, when the driver sets the ``V4L2_CTRL_FLAG_DISABLED`` flag
in the ``flags`` field this control is permanently disabled and should
-be ignored by the application. [1]_
+be ignored by the application. [#f1]_
When the application ORs ``id`` with ``V4L2_CTRL_FLAG_NEXT_CTRL`` the
driver returns the next supported non-compound control, or ``EINVAL`` if
@@ -776,7 +776,7 @@ EINVAL
EACCES
An attempt was made to read a write-only control.
-.. [1]
+.. [#f1]
``V4L2_CTRL_FLAG_DISABLED`` was intended for two purposes: Drivers
can skip predefined controls not supported by the hardware (although
returning ``EINVAL`` would do as well), or disable predefined and private
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH 2/2] [media] docs-rst: escape [] characters
2016-07-13 11:15 [PATCH 1/2] [media] doc-rst: use the right markup for footnotes Mauro Carvalho Chehab
@ 2016-07-13 11:15 ` Mauro Carvalho Chehab
2016-07-13 11:43 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-13 11:15 UTC (permalink / raw)
Cc: Mauro Carvalho Chehab, Linux Media Mailing List,
Mauro Carvalho Chehab, Jonathan Corbet, linux-doc
Those characters are used for citations. Better to escape, to
avoid them to be misinterpreted.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/uapi/cec/cec-ioc-adap-g-caps.rst | 4 +-
.../media/uapi/cec/cec-ioc-adap-g-log-addrs.rst | 6 +--
Documentation/media/uapi/cec/cec-ioc-receive.rst | 2 +-
Documentation/media/uapi/dvb/ca_data_types.rst | 4 +-
Documentation/media/uapi/dvb/dmx-get-pes-pids.rst | 4 +-
Documentation/media/uapi/dvb/dtv-property.rst | 6 +--
Documentation/media/uapi/dvb/examples.rst | 18 +++----
.../media/uapi/dvb/fe-diseqc-recv-slave-reply.rst | 4 +-
.../media/uapi/dvb/fe-diseqc-send-master-cmd.rst | 4 +-
Documentation/media/uapi/dvb/fe-get-info.rst | 2 +-
Documentation/media/uapi/dvb/video_types.rst | 4 +-
.../media/uapi/mediactl/media-ioc-device-info.rst | 10 ++--
.../uapi/mediactl/media-ioc-enum-entities.rst | 4 +-
.../media/uapi/mediactl/media-ioc-g-topology.rst | 10 ++--
Documentation/media/uapi/rc/keytable.c.rst | 42 +++++++--------
Documentation/media/uapi/v4l/buffer.rst | 4 +-
Documentation/media/uapi/v4l/capture.c.rst | 14 ++---
Documentation/media/uapi/v4l/dev-osd.rst | 2 +-
Documentation/media/uapi/v4l/dev-raw-vbi.rst | 4 +-
.../media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf | Bin 3683 -> 3685 bytes
Documentation/media/uapi/v4l/dev-sdr.rst | 2 +-
Documentation/media/uapi/v4l/dev-sliced-vbi.rst | 58 ++++++++++-----------
Documentation/media/uapi/v4l/hist-v4l2.rst | 10 ++--
Documentation/media/uapi/v4l/pixfmt-003.rst | 4 +-
Documentation/media/uapi/v4l/subdev-formats.rst | 2 +-
Documentation/media/uapi/v4l/v4l2grab.c.rst | 2 +-
.../media/uapi/v4l/vidioc-create-bufs.rst | 2 +-
.../media/uapi/v4l/vidioc-dbg-g-chip-info.rst | 6 +--
.../media/uapi/v4l/vidioc-dbg-g-register.rst | 2 +-
.../media/uapi/v4l/vidioc-decoder-cmd.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-dqevent.rst | 4 +-
.../media/uapi/v4l/vidioc-dv-timings-cap.rst | 6 +--
.../media/uapi/v4l/vidioc-encoder-cmd.rst | 2 +-
.../media/uapi/v4l/vidioc-enum-dv-timings.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-enum-fmt.rst | 4 +-
.../media/uapi/v4l/vidioc-enum-frameintervals.rst | 2 +-
.../media/uapi/v4l/vidioc-enum-framesizes.rst | 2 +-
.../media/uapi/v4l/vidioc-enum-freq-bands.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-enuminput.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-enumoutput.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-enumstd.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-expbuf.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-g-audio.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-g-audioout.rst | 4 +-
.../media/uapi/v4l/vidioc-g-dv-timings.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-g-edid.rst | 2 +-
.../media/uapi/v4l/vidioc-g-enc-index.rst | 4 +-
.../media/uapi/v4l/vidioc-g-ext-ctrls.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-g-fmt.rst | 2 +-
.../media/uapi/v4l/vidioc-g-frequency.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst | 4 +-
.../media/uapi/v4l/vidioc-g-modulator.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-g-parm.rst | 6 +--
.../media/uapi/v4l/vidioc-g-selection.rst | 2 +-
.../media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst | 16 +++---
Documentation/media/uapi/v4l/vidioc-g-tuner.rst | 4 +-
Documentation/media/uapi/v4l/vidioc-querycap.rst | 8 +--
Documentation/media/uapi/v4l/vidioc-queryctrl.rst | 12 ++---
Documentation/media/uapi/v4l/vidioc-reqbufs.rst | 2 +-
.../media/uapi/v4l/vidioc-s-hw-freq-seek.rst | 2 +-
.../uapi/v4l/vidioc-subdev-enum-frame-interval.rst | 2 +-
.../uapi/v4l/vidioc-subdev-enum-frame-size.rst | 2 +-
.../uapi/v4l/vidioc-subdev-enum-mbus-code.rst | 2 +-
.../media/uapi/v4l/vidioc-subdev-g-crop.rst | 2 +-
.../media/uapi/v4l/vidioc-subdev-g-fmt.rst | 2 +-
.../uapi/v4l/vidioc-subdev-g-frame-interval.rst | 2 +-
.../media/uapi/v4l/vidioc-subdev-g-selection.rst | 2 +-
.../media/uapi/v4l/vidioc-subscribe-event.rst | 2 +-
68 files changed, 188 insertions(+), 188 deletions(-)
diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
index 2ca9199c3305..8d9d55757d45 100644
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
@@ -52,7 +52,7 @@ returns the information to the application. The ioctl never fails.
- char
- - ``driver[32]``
+ - ``driver\[32\]``
- The name of the cec adapter driver.
@@ -60,7 +60,7 @@ returns the information to the application. The ioctl never fails.
- char
- - ``name[32]``
+ - ``name\[32\]``
- The name of this CEC adapter. The combination ``driver`` and
``name`` must be unique.
diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst
index 7d7a3b43aedc..c52b8888d381 100644
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst
@@ -70,7 +70,7 @@ by a file handle in initiator mode (see
- The actual logical addresses that were claimed. This is set by the
driver. If no logical address could be claimed, then it is set to
``CEC_LOG_ADDR_INVALID``. If this adapter is Unregistered, then
- ``log_addr[0]`` is set to 0xf and all others to
+ ``log_addr\[0\]`` is set to 0xf and all others to
``CEC_LOG_ADDR_INVALID``.
- .. row 2
@@ -138,7 +138,7 @@ by a file handle in initiator mode (see
- char
- - ``osd_name``\ [15]
+ - ``osd_name``\ \[15\]
- The On-Screen Display name as is returned by the
``CEC_MSG_SET_OSD_NAME`` message.
@@ -178,7 +178,7 @@ by a file handle in initiator mode (see
- __u8
- - ``features`` [CEC_MAX_LOG_ADDRS][12]
+ - ``features`` [CEC_MAX_LOG_ADDRS]\[12\]
- Features for each logical address. Used to implement the
``CEC_MSG_REPORT_FEATURES`` message. The 12 bytes include both the
diff --git a/Documentation/media/uapi/cec/cec-ioc-receive.rst b/Documentation/media/uapi/cec/cec-ioc-receive.rst
index 47aadcd553ee..9a16a3d38340 100644
--- a/Documentation/media/uapi/cec/cec-ioc-receive.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-receive.rst
@@ -139,7 +139,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- __u8
- - ``msg``\ [16]
+ - ``msg``\ \[16\]
- The message payload. For :ref:`CEC_TRANSMIT` this is filled in by the
application. The driver will fill this in for :ref:`CEC_RECEIVE` and
diff --git a/Documentation/media/uapi/dvb/ca_data_types.rst b/Documentation/media/uapi/dvb/ca_data_types.rst
index 025f910ae945..8a776c855aab 100644
--- a/Documentation/media/uapi/dvb/ca_data_types.rst
+++ b/Documentation/media/uapi/dvb/ca_data_types.rst
@@ -77,7 +77,7 @@ ca_msg_t
unsigned int index;
unsigned int type;
unsigned int length;
- unsigned char msg[256];
+ unsigned char msg\[256\];
} ca_msg_t;
@@ -92,7 +92,7 @@ ca_descr_t
typedef struct ca_descr {
unsigned int index;
unsigned int parity;
- unsigned char cw[8];
+ unsigned char cw\[8\];
} ca_descr_t;
diff --git a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst b/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
index ba5d30c913c8..dcca37c7cec1 100644
--- a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
+++ b/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
@@ -15,7 +15,7 @@ DMX_GET_PES_PIDS
Synopsis
--------
-.. cpp:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
+.. cpp:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16\[5\])
Arguments
@@ -40,7 +40,7 @@ Arguments
- .. row 3
- - __u16[5]
+ - __u16\[5\]
- Undocumented.
diff --git a/Documentation/media/uapi/dvb/dtv-property.rst b/Documentation/media/uapi/dvb/dtv-property.rst
index 5073a49def2a..219111ebc7f5 100644
--- a/Documentation/media/uapi/dvb/dtv-property.rst
+++ b/Documentation/media/uapi/dvb/dtv-property.rst
@@ -13,14 +13,14 @@ struct dtv_property
struct dtv_property {
__u32 cmd;
- __u32 reserved[3];
+ __u32 reserved\[3\];
union {
__u32 data;
struct dtv_fe_stats st;
struct {
- __u8 data[32];
+ __u8 data\[32\];
__u32 len;
- __u32 reserved1[3];
+ __u32 reserved1\[3\];
void *reserved2;
} buffer;
} u;
diff --git a/Documentation/media/uapi/dvb/examples.rst b/Documentation/media/uapi/dvb/examples.rst
index bf0a8617de92..e23ad9fb2008 100644
--- a/Documentation/media/uapi/dvb/examples.rst
+++ b/Documentation/media/uapi/dvb/examples.rst
@@ -87,7 +87,7 @@ tuners, but can easily be adjusted for QAM.
struct secCmdSequence scmds;
struct dmx_pes_filter_params pesFilterParams;
FrontendParameters frp;
- struct pollfd pfd[1];
+ struct pollfd pfd\[1\];
FrontendEvent event;
int demux1, demux2, demux3, front;
@@ -143,7 +143,7 @@ tuners, but can easily be adjusted for QAM.
scmd.u.diseqc.addr=0x10;
scmd.u.diseqc.cmd=0x38;
scmd.u.diseqc.numParams=1;
- scmd.u.diseqc.params[0] = 0xF0 | ((diseqc * 4) & 0x0F) |
+ scmd.u.diseqc.params\[0\] = 0xF0 | ((diseqc * 4) & 0x0F) |
(scmds.continuousTone == SEC_TONE_ON ? 1 : 0) |
(scmds.voltage==SEC_VOLTAGE_18 ? 2 : 0);
@@ -168,11 +168,11 @@ tuners, but can easily be adjusted for QAM.
return -1;
}
- pfd[0].fd = front;
- pfd[0].events = POLLIN;
+ pfd\[0\].fd = front;
+ pfd\[0\].events = POLLIN;
if (poll(pfd,1,3000)){
- if (pfd[0].revents & POLLIN){
+ if (pfd\[0\].revents & POLLIN){
printf("Getting QPSK event\\n");
if ( ioctl(front, FE_GET_EVENT, &event)
@@ -324,7 +324,7 @@ recording.
int written;
uint8_t buf[BUFFY];
uint64_t length;
- struct pollfd pfd[1];
+ struct pollfd pfd\[1\];
int dvr, dvr_out;
/* open dvr device */
@@ -351,13 +351,13 @@ recording.
return -1;
}
- pfd[0].fd = dvr;
- pfd[0].events = POLLIN;
+ pfd\[0\].fd = dvr;
+ pfd\[0\].events = POLLIN;
/* poll for dvr data and write to file */
while (length < MAX_LENGTH ) {
if (poll(pfd,1,1)){
- if (pfd[0].revents & POLLIN){
+ if (pfd\[0\].revents & POLLIN){
len = read(dvr, buf, BUFFY);
if (len < 0){
perror("recording");
diff --git a/Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst
index 7bd02ac7bff4..0c356fcb6f08 100644
--- a/Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst
+++ b/Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst
@@ -52,9 +52,9 @@ struct dvb_diseqc_slave_reply
- uint8_t
- - msg[4]
+ - msg\[4\]
- - DiSEqC message (framing, data[3])
+ - DiSEqC message (framing, data\[3\])
- .. row 2
diff --git a/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst
index 58a5e6ac10bd..a60b8dd157fe 100644
--- a/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst
+++ b/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst
@@ -52,9 +52,9 @@ struct dvb_diseqc_master_cmd
- uint8_t
- - msg[6]
+ - msg\[6\]
- - DiSEqC message (framing, address, command, data[3])
+ - DiSEqC message (framing, address, command, data\[3\])
- .. row 2
diff --git a/Documentation/media/uapi/dvb/fe-get-info.rst b/Documentation/media/uapi/dvb/fe-get-info.rst
index bb6c32e47ce8..4176977f07b3 100644
--- a/Documentation/media/uapi/dvb/fe-get-info.rst
+++ b/Documentation/media/uapi/dvb/fe-get-info.rst
@@ -57,7 +57,7 @@ struct dvb_frontend_info
- char
- - name[128]
+ - name\[128\]
- Name of the frontend
diff --git a/Documentation/media/uapi/dvb/video_types.rst b/Documentation/media/uapi/dvb/video_types.rst
index 671f365ceeb4..d4debb36580d 100644
--- a/Documentation/media/uapi/dvb/video_types.rst
+++ b/Documentation/media/uapi/dvb/video_types.rst
@@ -125,7 +125,7 @@ it can be extended safely in the future.
} play;
struct {
- __u32 data[16];
+ __u32 data\[16\];
} raw;
};
};
@@ -352,7 +352,7 @@ passed to the ioctl VIDEO_GET_NAVI:
typedef
struct video_navi_pack {
int length; /* 0 ... 1024 */
- uint8_t data[1024];
+ uint8_t data\[1024\];
} video_navi_pack_t;
diff --git a/Documentation/media/uapi/mediactl/media-ioc-device-info.rst b/Documentation/media/uapi/mediactl/media-ioc-device-info.rst
index 467d82cbb81e..e7d9570a020f 100644
--- a/Documentation/media/uapi/mediactl/media-ioc-device-info.rst
+++ b/Documentation/media/uapi/mediactl/media-ioc-device-info.rst
@@ -52,7 +52,7 @@ ioctl never fails.
- char
- - ``driver``\ [16]
+ - ``driver``\ \[16\]
- Name of the driver implementing the media API as a NUL-terminated
ASCII string. The driver version is stored in the
@@ -66,7 +66,7 @@ ioctl never fails.
- char
- - ``model``\ [32]
+ - ``model``\ \[32\]
- Device model name as a NUL-terminated UTF-8 string. The device
version is stored in the ``device_version`` field and is not be
@@ -76,7 +76,7 @@ ioctl never fails.
- char
- - ``serial``\ [40]
+ - ``serial``\ \[40\]
- Serial number as a NUL-terminated ASCII string.
@@ -84,7 +84,7 @@ ioctl never fails.
- char
- - ``bus_info``\ [32]
+ - ``bus_info``\ \[32\]
- Location of the device in the system as a NUL-terminated ASCII
string. This includes the bus type name (PCI, USB, ...) and a
@@ -120,7 +120,7 @@ ioctl never fails.
- __u32
- - ``reserved``\ [31]
+ - ``reserved``\ \[31\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst b/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst
index 12d4b25d5b94..181eef6a34e6 100644
--- a/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst
+++ b/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst
@@ -75,7 +75,7 @@ id's until they get an error.
- char
- - ``name``\ [32]
+ - ``name``\ \[32\]
-
-
@@ -181,7 +181,7 @@ id's until they get an error.
-
- __u8
- - ``raw``\ [184]
+ - ``raw``\ \[184\]
-
-
diff --git a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst b/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
index 2e382cc7762c..6fc564dde397 100644
--- a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
+++ b/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
@@ -163,7 +163,7 @@ desired arrays with the media graph elements.
- char
- - ``name``\ [64]
+ - ``name``\ \[64\]
- Entity name as an UTF-8 NULL-terminated string.
@@ -179,7 +179,7 @@ desired arrays with the media graph elements.
- __u32
- - ``reserved``\ [12]
+ - ``reserved``\ \[12\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -221,7 +221,7 @@ desired arrays with the media graph elements.
- __u32
- - ``reserved``\ [9]
+ - ``reserved``\ \[9\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -299,7 +299,7 @@ desired arrays with the media graph elements.
- __u32
- - ``reserved``\ [9]
+ - ``reserved``\ \[9\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -354,7 +354,7 @@ desired arrays with the media graph elements.
- __u32
- - ``reserved``\ [5]
+ - ``reserved``\ \[5\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
diff --git a/Documentation/media/uapi/rc/keytable.c.rst b/Documentation/media/uapi/rc/keytable.c.rst
index e6ce1e3f5a78..5ee6e8c6639d 100644
--- a/Documentation/media/uapi/rc/keytable.c.rst
+++ b/Documentation/media/uapi/rc/keytable.c.rst
@@ -35,16 +35,16 @@ file: uapi/v4l/keytable.c
struct parse_key *p;
for (p=keynames;p->name!=NULL;p++) {
- if (p->value == (unsigned)codes[1]) {
- printf("scancode 0x%04x = %s (0x%02x)\\n", codes[0], p->name, codes[1]);
+ if (p->value == (unsigned)codes\[1\]) {
+ printf("scancode 0x%04x = %s (0x%02x)\\n", codes\[0\], p->name, codes\[1\]);
return;
}
}
- if (isprint (codes[1]))
- printf("scancode %d = '%c' (0x%02x)\\n", codes[0], codes[1], codes[1]);
+ if (isprint (codes\[1\]))
+ printf("scancode %d = '%c' (0x%02x)\\n", codes\[0\], codes\[1\], codes\[1\]);
else
- printf("scancode %d = 0x%02x\\n", codes[0], codes[1]);
+ printf("scancode %d = 0x%02x\\n", codes\[0\], codes\[1\]);
}
int parse_code(char *string)
@@ -63,7 +63,7 @@ file: uapi/v4l/keytable.c
{
int fd;
unsigned int i, j;
- int codes[2];
+ int codes\[2\];
if (argc<2 || argc>4) {
printf ("usage: %s <device> to get table; or\\n"
@@ -72,7 +72,7 @@ file: uapi/v4l/keytable.c
return -1;
}
- if ((fd = open(argv[1], O_RDONLY)) < 0) {
+ if ((fd = open(argv\[1\], O_RDONLY)) < 0) {
perror("Couldn't open input device");
return(-1);
}
@@ -80,16 +80,16 @@ file: uapi/v4l/keytable.c
if (argc==4) {
int value;
- value=parse_code(argv[3]);
+ value=parse_code(argv\[3\]);
if (value==-1) {
- value = strtol(argv[3], NULL, 0);
+ value = strtol(argv\[3\], NULL, 0);
if (errno)
perror("value");
}
- codes [0] = (unsigned) strtol(argv[2], NULL, 0);
- codes [1] = (unsigned) value;
+ codes \[0\] = (unsigned) strtol(argv\[2\], NULL, 0);
+ codes \[1\] = (unsigned) value;
if(ioctl(fd, EVIOCSKEYCODE, codes))
perror ("EVIOCSKEYCODE");
@@ -102,9 +102,9 @@ file: uapi/v4l/keytable.c
if (argc==3) {
FILE *fin;
int value;
- char *scancode, *keycode, s[2048];
+ char *scancode, *keycode, s\[2048\];
- fin=fopen(argv[2],"r");
+ fin=fopen(argv\[2\],"r");
if (fin==NULL) {
perror ("opening keycode file");
return -1;
@@ -113,8 +113,8 @@ file: uapi/v4l/keytable.c
/* Clears old table */
for (j = 0; j < 256; j++) {
for (i = 0; i < 256; i++) {
- codes[0] = (j << 8) | i;
- codes[1] = KEY_RESERVED;
+ codes\[0\] = (j << 8) | i;
+ codes\[1\] = KEY_RESERVED;
ioctl(fd, EVIOCSKEYCODE, codes);
}
}
@@ -149,12 +149,12 @@ file: uapi/v4l/keytable.c
perror("value");
}
- codes [0] = (unsigned) strtol(scancode, NULL, 0);
- codes [1] = (unsigned) value;
+ codes \[0\] = (unsigned) strtol(scancode, NULL, 0);
+ codes \[1\] = (unsigned) value;
- // printf("\\t%04x=%04x\\n",codes[0], codes[1]);
+ // printf("\\t%04x=%04x\\n",codes\[0\], codes\[1\]);
if(ioctl(fd, EVIOCSKEYCODE, codes)) {
- fprintf(stderr, "Setting scancode 0x%04x with 0x%04x via ",codes[0], codes[1]);
+ fprintf(stderr, "Setting scancode 0x%04x with 0x%04x via ",codes\[0\], codes\[1\]);
perror ("EVIOCSKEYCODE");
}
@@ -167,8 +167,8 @@ file: uapi/v4l/keytable.c
/* Get scancode table */
for (j = 0; j < 256; j++) {
for (i = 0; i < 256; i++) {
- codes[0] = (j << 8) | i;
- if (!ioctl(fd, EVIOCGKEYCODE, codes) && codes[1] != KEY_RESERVED)
+ codes\[0\] = (j << 8) | i;
+ if (!ioctl(fd, EVIOCGKEYCODE, codes) && codes\[1\] != KEY_RESERVED)
prtcode(codes);
}
}
diff --git a/Documentation/media/uapi/v4l/buffer.rst b/Documentation/media/uapi/v4l/buffer.rst
index 5deb4a46f992..ba22464c0fcc 100644
--- a/Documentation/media/uapi/v4l/buffer.rst
+++ b/Documentation/media/uapi/v4l/buffer.rst
@@ -379,7 +379,7 @@ struct v4l2_plane
- __u32
- - ``reserved[11]``
+ - ``reserved\[11\]``
-
- Reserved for future use. Should be zeroed by drivers and
@@ -868,7 +868,7 @@ struct v4l2_timecode
- __u8
- - ``userbits``\ [4]
+ - ``userbits``\ \[4\]
- The "user group" bits from the timecode.
diff --git a/Documentation/media/uapi/v4l/capture.c.rst b/Documentation/media/uapi/v4l/capture.c.rst
index 56525a0fb2fa..4f0dead97ad2 100644
--- a/Documentation/media/uapi/v4l/capture.c.rst
+++ b/Documentation/media/uapi/v4l/capture.c.rst
@@ -88,7 +88,7 @@ file: media/v4l/capture.c
switch (io) {
case IO_METHOD_READ:
- if (-1 == read(fd, buffers[0].start, buffers[0].length)) {
+ if (-1 == read(fd, buffers\[0\].start, buffers\[0\].length)) {
switch (errno) {
case EAGAIN:
return 0;
@@ -103,7 +103,7 @@ file: media/v4l/capture.c
}
}
- process_image(buffers[0].start, buffers[0].length);
+ process_image(buffers\[0\].start, buffers\[0\].length);
break;
case IO_METHOD_MMAP:
@@ -284,7 +284,7 @@ file: media/v4l/capture.c
switch (io) {
case IO_METHOD_READ:
- free(buffers[0].start);
+ free(buffers\[0\].start);
break;
case IO_METHOD_MMAP:
@@ -311,10 +311,10 @@ file: media/v4l/capture.c
exit(EXIT_FAILURE);
}
- buffers[0].length = buffer_size;
- buffers[0].start = malloc(buffer_size);
+ buffers\[0\].length = buffer_size;
+ buffers\[0\].start = malloc(buffer_size);
- if (!buffers[0].start) {
+ if (!buffers\[0\].start) {
fprintf(stderr, "Out of memory\\n");
exit(EXIT_FAILURE);
}
@@ -575,7 +575,7 @@ file: media/v4l/capture.c
"-f | --format Force format to 640x480 YUYVn"
"-c | --count Number of frames to grab [%i]n"
"",
- argv[0], dev_name, frame_count);
+ argv\[0\], dev_name, frame_count);
}
static const char short_options[] = "d:hmruofc:";
diff --git a/Documentation/media/uapi/v4l/dev-osd.rst b/Documentation/media/uapi/v4l/dev-osd.rst
index fadda131f020..36129cf4e92a 100644
--- a/Documentation/media/uapi/v4l/dev-osd.rst
+++ b/Documentation/media/uapi/v4l/dev-osd.rst
@@ -68,7 +68,7 @@ Example: Finding a framebuffer device for OSD
}
for (i = 0; i < 30; i++) {
- char dev_name[16];
+ char dev_name\[16\];
struct fb_fix_screeninfo si;
snprintf(dev_name, sizeof(dev_name), "/dev/fb%u", i);
diff --git a/Documentation/media/uapi/v4l/dev-raw-vbi.rst b/Documentation/media/uapi/v4l/dev-raw-vbi.rst
index d5a4b3530b69..eea4c05a0cd4 100644
--- a/Documentation/media/uapi/v4l/dev-raw-vbi.rst
+++ b/Documentation/media/uapi/v4l/dev-raw-vbi.rst
@@ -188,7 +188,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
service transmissions embedded in the picture.
An application can set the first or second ``count`` value to zero
- if no data is required from the respective field; ``count``\ [1]
+ if no data is required from the respective field; ``count``\ \[1\]
if the scanning system is progressive, i. e. not interlaced. The
corresponding start value shall be ignored by the application and
driver. Anyway, drivers may not support single field capturing and
@@ -318,7 +318,7 @@ The total size of a frame computes as follows:
.. code-block:: c
- (count[0] + count[1]) * samples_per_line * sample size in bytes
+ (count\[0\] + count\[1\]) * samples_per_line * sample size in bytes
The sample size is most likely always one byte, applications must check
the ``sample_format`` field though, to function properly with other
diff --git a/Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf b/Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf
index 765235e33a4de256a0b3fbf64ffe52946190cac4..f672b52ef683b3b6da4a43167f67ecbecfd6dc36 100644
GIT binary patch
delta 18
ZcmaDX^HgR-AtP%{w54Ut<`TyDJOD)g2G9Ti
delta 16
XcmaDV^H^p>AtQ6NrRC-_#`in`I2#5S
diff --git a/Documentation/media/uapi/v4l/dev-sdr.rst b/Documentation/media/uapi/v4l/dev-sdr.rst
index fc4053f957fb..2bb560580b75 100644
--- a/Documentation/media/uapi/v4l/dev-sdr.rst
+++ b/Documentation/media/uapi/v4l/dev-sdr.rst
@@ -110,7 +110,7 @@ data transfer, set by the driver in order to inform application.
- __u8
- - ``reserved[24]``
+ - ``reserved\[24\]``
- This array is reserved for future extensions. Drivers and
applications must set it to zero.
diff --git a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst b/Documentation/media/uapi/v4l/dev-sliced-vbi.rst
index ec52a825f4d6..7df760367021 100644
--- a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst
+++ b/Documentation/media/uapi/v4l/dev-sliced-vbi.rst
@@ -140,7 +140,7 @@ struct v4l2_sliced_vbi_format
- __u16
- - ``service_lines``\ [2][24]
+ - ``service_lines``\ \[2\]\[24\]
- :cspan:`2`
@@ -170,7 +170,7 @@ struct v4l2_sliced_vbi_format
-
-
- - ``service_lines``\ [0][1]
+ - ``service_lines``\ \[0\]\[1\]
- 1
@@ -180,7 +180,7 @@ struct v4l2_sliced_vbi_format
-
-
- - ``service_lines``\ [0][23]
+ - ``service_lines``\ \[0\]\[23\]
- 23
@@ -190,7 +190,7 @@ struct v4l2_sliced_vbi_format
-
-
- - ``service_lines``\ [1][1]
+ - ``service_lines``\ \[1\]\[1\]
- 264
@@ -200,7 +200,7 @@ struct v4l2_sliced_vbi_format
-
-
- - ``service_lines``\ [1][23]
+ - ``service_lines``\ \[1\]\[23\]
- 286
@@ -210,8 +210,8 @@ struct v4l2_sliced_vbi_format
-
-
- - :cspan:`2` Drivers must set ``service_lines`` [0][0] and
- ``service_lines``\ [1][0] to zero. The
+ - :cspan:`2` Drivers must set ``service_lines`` \[0\]\[0\] and
+ ``service_lines``\ \[1\]\[0\] to zero. The
``V4L2_VBI_ITU_525_F1_START``, ``V4L2_VBI_ITU_525_F2_START``,
``V4L2_VBI_ITU_625_F1_START`` and ``V4L2_VBI_ITU_625_F2_START``
defines give the start line numbers for each field for each 525 or
@@ -238,7 +238,7 @@ struct v4l2_sliced_vbi_format
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- :cspan:`2` This array is reserved for future extensions.
Applications and drivers must set it to zero.
@@ -427,7 +427,7 @@ struct v4l2_sliced_vbi_data
- __u8
- - ``data``\ [48]
+ - ``data``\ \[48\]
- The packet payload. See :ref:`vbi-services` for the contents and
number of bytes passed for each data type. The contents of padding
@@ -566,7 +566,7 @@ struct v4l2_mpeg_vbi_fmt_ivtv
- __u8
- - ``magic``\ [4]
+ - ``magic``\ \[4\]
-
- A "magic" constant from :ref:`v4l2-mpeg-vbi-fmt-ivtv-magic` that
@@ -662,7 +662,7 @@ struct v4l2_mpeg_vbi_itv0
- __le32
- - ``linemask``\ [2]
+ - ``linemask``\ \[2\]
- Bitmasks indicating the VBI service lines present. These
``linemask`` values are stored in little endian byte order in the
@@ -675,30 +675,30 @@ struct v4l2_mpeg_vbi_itv0
::
- linemask[0] b0: line 6 first field
- linemask[0] b17: line 23 first field
- linemask[0] b18: line 6 second field
- linemask[0] b31: line 19 second field
- linemask[1] b0: line 20 second field
- linemask[1] b3: line 23 second field
- linemask[1] b4-b31: unused and set to 0
+ linemask\[0\] b0: line 6 first field
+ linemask\[0\] b17: line 23 first field
+ linemask\[0\] b18: line 6 second field
+ linemask\[0\] b31: line 19 second field
+ linemask\[1\] b0: line 20 second field
+ linemask\[1\] b3: line 23 second field
+ linemask\[1\] b4-b31: unused and set to 0
- .. row 2
- struct
:ref:`v4l2_mpeg_vbi_itv0_line <v4l2-mpeg-vbi-itv0-line>`
- - ``line``\ [35]
+ - ``line``\ \[35\]
- This is a variable length array that holds from 1 to 35 lines of
sliced VBI data. The sliced VBI data lines present correspond to
the bits set in the ``linemask`` array, starting from b\ :sub:`0`
- of ``linemask``\ [0] up through b\ :sub:`31` of ``linemask``\ [0],
- and from b\ :sub:`0` of ``linemask``\ [1] up through b\ :sub:`3` of
- ``linemask``\ [1]. ``line``\ [0] corresponds to the first bit
- found set in the ``linemask`` array, ``line``\ [1] corresponds to
+ of ``linemask``\ \[0\] up through b\ :sub:`31` of ``linemask``\ \[0\],
+ and from b\ :sub:`0` of ``linemask``\ \[1\] up through b\ :sub:`3` of
+ ``linemask``\ \[1\]. ``line``\ \[0\] corresponds to the first bit
+ found set in the ``linemask`` array, ``line``\ \[1\] corresponds to
the second bit found set in the ``linemask`` array, etc. If no
- ``linemask`` array bits are set, then ``line``\ [0] may contain
+ ``linemask`` array bits are set, then ``line``\ \[0\] may contain
one line of unspecified data that should be ignored by
applications.
@@ -720,11 +720,11 @@ struct v4l2_mpeg_vbi_ITV0
- struct
:ref:`v4l2_mpeg_vbi_itv0_line <v4l2-mpeg-vbi-itv0-line>`
- - ``line``\ [36]
+ - ``line``\ \[36\]
- - A fixed length array of 36 lines of sliced VBI data. ``line``\ [0]
- through ``line``\ [17] correspond to lines 6 through 23 of the
- first field. ``line``\ [18] through ``line``\ [35] corresponds to
+ - A fixed length array of 36 lines of sliced VBI data. ``line``\ \[0\]
+ through ``line``\ \[17\] correspond to lines 6 through 23 of the
+ first field. ``line``\ \[18\] through ``line``\ \[35\] corresponds to
lines 6 through 23 of the second field.
@@ -754,7 +754,7 @@ struct v4l2_mpeg_vbi_itv0_line
- __u8
- - ``data``\ [42]
+ - ``data``\ \[42\]
- The sliced VBI data for the line.
diff --git a/Documentation/media/uapi/v4l/hist-v4l2.rst b/Documentation/media/uapi/v4l/hist-v4l2.rst
index 3ba1c0c2df1a..3882fc7782d0 100644
--- a/Documentation/media/uapi/v4l/hist-v4l2.rst
+++ b/Documentation/media/uapi/v4l/hist-v4l2.rst
@@ -266,7 +266,7 @@ V4L2 Version 0.20 2000-11-23
A number of changes were made to the raw VBI interface.
1. Figures clarifying the line numbering scheme were added to the V4L2
- API specification. The ``start``\ [0] and ``start``\ [1] fields no
+ API specification. The ``start``\ \[0\] and ``start``\ \[1\] fields no
longer count line numbers beginning at zero. Rationale: a) The
previous definition was unclear. b) The ``start``\ [] values are
ordinal numbers. c) There is no point in inventing a new line
@@ -274,8 +274,8 @@ A number of changes were made to the raw VBI interface.
Compatibility: Add one to the start values. Applications depending on
the previous semantics may not function correctly.
-2. The restriction "count[0] > 0 and count[1] > 0" has been relaxed to
- "(count[0] + count[1]) > 0". Rationale: Drivers may allocate
+2. The restriction "count\[0\] > 0 and count\[1\] > 0" has been relaxed to
+ "(count\[0\] + count\[1\]) > 0". Rationale: Drivers may allocate
resources at scan line granularity and some data services are
transmitted only on the first field. The comment that both ``count``
values will usually be equal is misleading and pointless and has been
@@ -649,7 +649,7 @@ This unnamed version was finally merged into Linux 2.5.46.
memory. It was barely useful and so was removed.
14. In struct :ref:`v4l2_framebuffer <v4l2-framebuffer>` the
- ``base[3]`` array anticipating double- and triple-buffering in
+ ``base\[3\]`` array anticipating double- and triple-buffering in
off-screen video memory, however without defining a synchronization
mechanism, was replaced by a single pointer. The
``V4L2_FBUF_CAP_SCALEUP`` and ``V4L2_FBUF_CAP_SCALEDOWN`` flags were
@@ -833,7 +833,7 @@ V4L2 in Linux 2.6.6, 2004-05-09
V4L2 in Linux 2.6.8
===================
-1. A new field ``input`` (former ``reserved[0]``) was added to the
+1. A new field ``input`` (former ``reserved\[0\]``) was added to the
struct :ref:`v4l2_buffer <v4l2-buffer>` structure. Purpose of this
field is to alternate between video inputs (e. g. cameras) in step
with the video capturing process. This function must be enabled with
diff --git a/Documentation/media/uapi/v4l/pixfmt-003.rst b/Documentation/media/uapi/v4l/pixfmt-003.rst
index 25c54872fbe1..d6a80d16afbc 100644
--- a/Documentation/media/uapi/v4l/pixfmt-003.rst
+++ b/Documentation/media/uapi/v4l/pixfmt-003.rst
@@ -41,7 +41,7 @@ describing all planes of that format.
- __u16
- - ``reserved[6]``
+ - ``reserved\[6\]``
- Reserved for future extensions. Should be zeroed by drivers and
applications.
@@ -160,7 +160,7 @@ describing all planes of that format.
- __u8
- - ``reserved[7]``
+ - ``reserved\[7\]``
- Reserved for future extensions. Should be zeroed by drivers and
applications.
diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst b/Documentation/media/uapi/v4l/subdev-formats.rst
index 6dbb27b09c34..c365cf116308 100644
--- a/Documentation/media/uapi/v4l/subdev-formats.rst
+++ b/Documentation/media/uapi/v4l/subdev-formats.rst
@@ -92,7 +92,7 @@ Media Bus Formats
- __u16
- - ``reserved``\ [11]
+ - ``reserved``\ \[11\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/v4l2grab.c.rst b/Documentation/media/uapi/v4l/v4l2grab.c.rst
index 5aabd0b7b089..5d0263aab18c 100644
--- a/Documentation/media/uapi/v4l/v4l2grab.c.rst
+++ b/Documentation/media/uapi/v4l/v4l2grab.c.rst
@@ -62,7 +62,7 @@ file: media/v4l/v4l2grab.c
int r, fd = -1;
unsigned int i, n_buffers;
char *dev_name = "/dev/video0";
- char out_name[256];
+ char out_name\[256\];
FILE *fout;
struct buffer *buffers;
diff --git a/Documentation/media/uapi/v4l/vidioc-create-bufs.rst b/Documentation/media/uapi/v4l/vidioc-create-bufs.rst
index abdc0b4d83d5..45c28af5c523 100644
--- a/Documentation/media/uapi/v4l/vidioc-create-bufs.rst
+++ b/Documentation/media/uapi/v4l/vidioc-create-bufs.rst
@@ -125,7 +125,7 @@ than the number requested.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- A place holder for future extensions. Drivers and applications
must set the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst
index f7e1b80af29e..4c683a3457c2 100644
--- a/Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst
@@ -115,7 +115,7 @@ instructions.
-
- char
- - ``name[32]``
+ - ``name\[32\]``
- Match a chip by this name, interpreted according to the ``type``
field. Currently unused.
@@ -142,7 +142,7 @@ instructions.
- char
- - ``name[32]``
+ - ``name\[32\]``
- The name of the chip.
@@ -161,7 +161,7 @@ instructions.
- __u32
- - ``reserved[8]``
+ - ``reserved\[8\]``
- Reserved fields, both application and driver must set these to 0.
diff --git a/Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst b/Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst
index 09d2880e6170..d8ab629b087d 100644
--- a/Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst
@@ -123,7 +123,7 @@ instructions.
-
- char
- - ``name[32]``
+ - ``name\[32\]``
- Match a chip by this name, interpreted according to the ``type``
field. Currently unused.
diff --git a/Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst b/Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst
index 2a36e91b57b9..24419de4230e 100644
--- a/Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst
@@ -178,7 +178,7 @@ introduced in Linux 3.3.
-
- __u32
- - ``data``\ [16]
+ - ``data``\ \[16\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-dqevent.rst b/Documentation/media/uapi/v4l/vidioc-dqevent.rst
index 73c0d5be62ee..f426b195ceb8 100644
--- a/Documentation/media/uapi/v4l/vidioc-dqevent.rst
+++ b/Documentation/media/uapi/v4l/vidioc-dqevent.rst
@@ -116,7 +116,7 @@ call.
-
- __u8
- - ``data``\ [64]
+ - ``data``\ \[64\]
- Event data. Defined by the event type. The union should be used to
define easily accessible type for events.
@@ -167,7 +167,7 @@ call.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
-
- Reserved for future extensions. Drivers must set the array to
diff --git a/Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst b/Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst
index 6e05957013bb..1a78407896fe 100644
--- a/Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst
@@ -130,7 +130,7 @@ that doesn't support them will return an ``EINVAL`` error code.
- __u32
- - ``reserved``\ [16]
+ - ``reserved``\ \[16\]
- Reserved for future extensions. Drivers must set the array to
zero.
@@ -167,7 +167,7 @@ that doesn't support them will return an ``EINVAL`` error code.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@@ -193,7 +193,7 @@ that doesn't support them will return an ``EINVAL`` error code.
-
- __u32
- - ``raw_data``\ [32]
+ - ``raw_data``\ \[32\]
-
diff --git a/Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst b/Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst
index 69bd9b4e0e56..19b86603f4d7 100644
--- a/Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst
@@ -94,7 +94,7 @@ introduced in Linux 2.6.21.
- __u32
- - ``data``\ [8]
+ - ``data``\ \[8\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst b/Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst
index 3ba75d3fb93c..71e0ae65abd1 100644
--- a/Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst
@@ -92,7 +92,7 @@ return an ``EINVAL`` error code.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst b/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
index 90996f69d6ae..3846009a39a7 100644
--- a/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
@@ -86,7 +86,7 @@ one until ``EINVAL`` is returned.
- __u8
- - ``description``\ [32]
+ - ``description``\ \[32\]
- Description of the format, a NUL-terminated ASCII string. This
information is intended for the user, for example: "YUV 4:2:2".
@@ -120,7 +120,7 @@ one until ``EINVAL`` is returned.
- __u32
- - ``reserved``\ [4]
+ - ``reserved``\ \[4\]
- Reserved for future extensions. Drivers must set the array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst b/Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst
index ceae6003039e..6a2060b4a35c 100644
--- a/Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst
@@ -217,7 +217,7 @@ application should zero out all members except for the *IN* fields.
- __u32
- - ``reserved[2]``
+ - ``reserved\[2\]``
-
- Reserved space for future use. Must be zeroed by drivers and
diff --git a/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst b/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst
index 8b268354d442..7a6a43b519df 100644
--- a/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst
@@ -238,7 +238,7 @@ application should zero out all members except for the *IN* fields.
- __u32
- - ``reserved[2]``
+ - ``reserved\[2\]``
-
- Reserved space for future use. Must be zeroed by drivers and
diff --git a/Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst b/Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst
index 00ab5e19cc1d..19e86cfdbf39 100644
--- a/Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst
@@ -140,7 +140,7 @@ of the corresponding tuner/modulator is set.
- __u32
- - ``reserved``\ [9]
+ - ``reserved``\ \[9\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-enuminput.rst b/Documentation/media/uapi/v4l/vidioc-enuminput.rst
index 5060f54e3d18..1ea77135683a 100644
--- a/Documentation/media/uapi/v4l/vidioc-enuminput.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enuminput.rst
@@ -61,7 +61,7 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the video input, a NUL-terminated ASCII string, for
example: "Vin (Composite 2)". This information is intended for the
@@ -141,7 +141,7 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
- __u32
- - ``reserved``\ [3]
+ - ``reserved``\ \[3\]
- Reserved for future extensions. Drivers must set the array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-enumoutput.rst b/Documentation/media/uapi/v4l/vidioc-enumoutput.rst
index 82fc9d3b237f..83397f29903c 100644
--- a/Documentation/media/uapi/v4l/vidioc-enumoutput.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enumoutput.rst
@@ -62,7 +62,7 @@ EINVAL.
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the video output, a NUL-terminated ASCII string, for
example: "Vout". This information is intended for the user,
@@ -131,7 +131,7 @@ EINVAL.
- __u32
- - ``reserved``\ [3]
+ - ``reserved``\ \[3\]
- Reserved for future extensions. Drivers must set the array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-enumstd.rst b/Documentation/media/uapi/v4l/vidioc-enumstd.rst
index 6699b26cdeb4..e68a62803ac2 100644
--- a/Documentation/media/uapi/v4l/vidioc-enumstd.rst
+++ b/Documentation/media/uapi/v4l/vidioc-enumstd.rst
@@ -78,7 +78,7 @@ or output. [#f1]_
- __u8
- - ``name``\ [24]
+ - ``name``\ \[24\]
- Name of the standard, a NUL-terminated ASCII string, for example:
"PAL-B/G", "NTSC Japan". This information is intended for the
@@ -105,7 +105,7 @@ or output. [#f1]_
- __u32
- - ``reserved``\ [4]
+ - ``reserved``\ \[4\]
- Reserved for future extensions. Drivers must set the array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-expbuf.rst b/Documentation/media/uapi/v4l/vidioc-expbuf.rst
index ded708e647fa..bf7e644f9ff0 100644
--- a/Documentation/media/uapi/v4l/vidioc-expbuf.rst
+++ b/Documentation/media/uapi/v4l/vidioc-expbuf.rst
@@ -179,7 +179,7 @@ Examples
- __u32
- - ``reserved[11]``
+ - ``reserved\[11\]``
- Reserved field for future use. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-audio.rst b/Documentation/media/uapi/v4l/vidioc-g-audio.rst
index cccbcdb8c463..0a023c2b67ea 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-audio.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-audio.rst
@@ -70,7 +70,7 @@ return the actual new audio mode.
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the audio input, a NUL-terminated ASCII string, for
example: "Line In". This information is intended for the user,
@@ -97,7 +97,7 @@ return the actual new audio mode.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-audioout.rst b/Documentation/media/uapi/v4l/vidioc-g-audioout.rst
index b1c1bfeb251e..6442cb74ec94 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-audioout.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-audioout.rst
@@ -75,7 +75,7 @@ as ``VIDIOC_G_AUDOUT`` does.
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the audio output, a NUL-terminated ASCII string, for
example: "Line Out". This information is intended for the user,
@@ -103,7 +103,7 @@ as ``VIDIOC_G_AUDOUT`` does.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst b/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst
index f7bf21f49092..5c6aa7ae341e 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst
@@ -259,7 +259,7 @@ EBUSY
-
- __u32
- - ``reserved``\ [32]
+ - ``reserved``\ \[32\]
-
diff --git a/Documentation/media/uapi/v4l/vidioc-g-edid.rst b/Documentation/media/uapi/v4l/vidioc-g-edid.rst
index 1a982b68a72f..cf0d100863ca 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-edid.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-edid.rst
@@ -131,7 +131,7 @@ EDID is no longer available.
- __u32
- - ``reserved``\ [5]
+ - ``reserved``\ \[5\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-enc-index.rst b/Documentation/media/uapi/v4l/vidioc-g-enc-index.rst
index f0f41ac56b80..27b8c84dad6a 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-enc-index.rst
@@ -86,7 +86,7 @@ video elementary streams.
- __u32
- - ``reserved``\ [4]
+ - ``reserved``\ \[4\]
- :cspan:`2` Reserved for future extensions. Drivers must set the
array to zero.
@@ -153,7 +153,7 @@ video elementary streams.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers must set the array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst b/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst
index 39e24ad4b825..74998e028864 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst
@@ -136,7 +136,7 @@ still cause this situation.
- __u32
- - ``reserved2``\ [1]
+ - ``reserved2``\ \[1\]
-
- Reserved for future extensions. Drivers and applications must set
@@ -338,7 +338,7 @@ still cause this situation.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-fmt.rst b/Documentation/media/uapi/v4l/vidioc-g-fmt.rst
index ee6f11978fd6..9dc9e1e203a4 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-fmt.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-fmt.rst
@@ -171,7 +171,7 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
-
- __u8
- - ``raw_data``\ [200]
+ - ``raw_data``\ \[200\]
- Place holder for future extensions.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-frequency.rst b/Documentation/media/uapi/v4l/vidioc-g-frequency.rst
index a1fd2a870de4..8944f3bb5adb 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-frequency.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-frequency.rst
@@ -102,7 +102,7 @@ write-only ioctl, it does not return the actual new frequency.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst b/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst
index f5bf8b7915ed..6e084d3c30bb 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst
@@ -94,7 +94,7 @@ encoding. You usually do want to add them.
- char
- - ``APP_data``\ [60]
+ - ``APP_data``\ \[60\]
-
@@ -110,7 +110,7 @@ encoding. You usually do want to add them.
- char
- - ``COM_data``\ [60]
+ - ``COM_data``\ \[60\]
-
diff --git a/Documentation/media/uapi/v4l/vidioc-g-modulator.rst b/Documentation/media/uapi/v4l/vidioc-g-modulator.rst
index a2e8c73f0678..ee4cfc07f756 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-modulator.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-modulator.rst
@@ -81,7 +81,7 @@ To change the radio frequency the
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the modulator, a NUL-terminated ASCII string. This
information is intended for the user.
@@ -149,7 +149,7 @@ To change the radio frequency the
- __u32
- - ``reserved``\ [3]
+ - ``reserved``\ \[3\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-parm.rst b/Documentation/media/uapi/v4l/vidioc-g-parm.rst
index 7116e0decddc..80378272cdef 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-parm.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-parm.rst
@@ -103,7 +103,7 @@ union holding separate parameters for input and output devices.
-
- __u8
- - ``raw_data``\ [200]
+ - ``raw_data``\ \[200\]
- A place holder for future extensions.
@@ -183,7 +183,7 @@ union holding separate parameters for input and output devices.
- __u32
- - ``reserved``\ [4]
+ - ``reserved``\ \[4\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
@@ -271,7 +271,7 @@ union holding separate parameters for input and output devices.
- __u32
- - ``reserved``\ [4]
+ - ``reserved``\ \[4\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-selection.rst b/Documentation/media/uapi/v4l/vidioc-g-selection.rst
index 953931fabd00..e17ff45bd208 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-selection.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-selection.rst
@@ -182,7 +182,7 @@ Selection targets and flags are documented in
- __u32
- - ``reserved[9]``
+ - ``reserved\[9\]``
- Reserved fields for future use. Drivers and applications must zero
this array.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst
index f1f661d0200c..b9c44b22cda1 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -65,7 +65,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
- __u16
- - ``service_lines``\ [2][24]
+ - ``service_lines``\ \[2\]\[24\]
- :cspan:`2` Each element of this array contains a set of data
services the hardware can look for or insert into a particular
@@ -87,7 +87,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
-
-
- - ``service_lines``\ [0][1]
+ - ``service_lines``\ \[0\]\[1\]
- 1
@@ -97,7 +97,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
-
-
- - ``service_lines``\ [0][23]
+ - ``service_lines``\ \[0\]\[23\]
- 23
@@ -107,7 +107,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
-
-
- - ``service_lines``\ [1][1]
+ - ``service_lines``\ \[1\]\[1\]
- 264
@@ -117,7 +117,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
-
-
- - ``service_lines``\ [1][23]
+ - ``service_lines``\ \[1\]\[23\]
- 286
@@ -147,8 +147,8 @@ the sliced VBI API is unsupported or ``type`` is invalid.
-
-
- - :cspan:`2` Drivers must set ``service_lines`` [0][0] and
- ``service_lines``\ [1][0] to zero.
+ - :cspan:`2` Drivers must set ``service_lines`` \[0\]\[0\] and
+ ``service_lines``\ \[1\]\[0\] to zero.
- .. row 12
@@ -164,7 +164,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
- __u32
- - ``reserved``\ [3]
+ - ``reserved``\ \[3\]
- :cspan:`2` This array is reserved for future extensions.
Applications and drivers must set it to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-g-tuner.rst b/Documentation/media/uapi/v4l/vidioc-g-tuner.rst
index 614db06b8b4b..f9b0bfeef859 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-tuner.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-tuner.rst
@@ -79,7 +79,7 @@ To change the radio frequency the
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- :cspan:`1`
@@ -246,7 +246,7 @@ To change the radio frequency the
- __u32
- - ``reserved``\ [4]
+ - ``reserved``\ \[4\]
- :cspan:`1` Reserved for future extensions. Drivers and
applications must set the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-querycap.rst b/Documentation/media/uapi/v4l/vidioc-querycap.rst
index b10fed313f99..769a554dd8b9 100644
--- a/Documentation/media/uapi/v4l/vidioc-querycap.rst
+++ b/Documentation/media/uapi/v4l/vidioc-querycap.rst
@@ -53,7 +53,7 @@ specification the ioctl returns an ``EINVAL`` error code.
- __u8
- - ``driver``\ [16]
+ - ``driver``\ \[16\]
- Name of the driver, a unique NUL-terminated ASCII string. For
example: "bttv". Driver specific applications can use this
@@ -69,7 +69,7 @@ specification the ioctl returns an ``EINVAL`` error code.
- __u8
- - ``card``\ [32]
+ - ``card``\ \[32\]
- Name of the device, a NUL-terminated UTF-8 string. For example:
"Yoyodyne TV/FM". One driver may support different brands or
@@ -84,7 +84,7 @@ specification the ioctl returns an ``EINVAL`` error code.
- __u8
- - ``bus_info``\ [32]
+ - ``bus_info``\ \[32\]
- Location of the device in the system, a NUL-terminated ASCII
string. For example: "PCI:0000:05:06.0". This information is
@@ -166,7 +166,7 @@ specification the ioctl returns an ``EINVAL`` error code.
- __u32
- - ``reserved``\ [3]
+ - ``reserved``\ \[3\]
- Reserved for future extensions. Drivers must set this array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
index 8d6e61a7284d..72bc7b1b067c 100644
--- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
+++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
@@ -124,7 +124,7 @@ See also the examples in :ref:`control`.
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the control, a NUL-terminated ASCII string. This
information is intended for the user.
@@ -203,7 +203,7 @@ See also the examples in :ref:`control`.
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- Reserved for future extensions. Drivers must set the array to
zero.
@@ -245,7 +245,7 @@ See also the examples in :ref:`control`.
- char
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the control, a NUL-terminated ASCII string. This
information is intended for the user.
@@ -326,7 +326,7 @@ See also the examples in :ref:`control`.
- The size in bytes of a single element of the array. Given a char
pointer ``p`` to a 3-dimensional array you can find the position
of cell ``(z, y, x)`` as follows:
- ``p + ((z * dims[1] + y) * dims[0] + x) * elem_size``.
+ ``p + ((z * dims\[1\] + y) * dims\[0\] + x) * elem_size``.
``elem_size`` is always valid, also when the control isn't an
array. For string controls ``elem_size`` is equal to
``maximum + 1``.
@@ -363,7 +363,7 @@ See also the examples in :ref:`control`.
- __u32
- - ``reserved``\ [32]
+ - ``reserved``\ \[32\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
@@ -410,7 +410,7 @@ See also the examples in :ref:`control`.
-
- __u8
- - ``name``\ [32]
+ - ``name``\ \[32\]
- Name of the menu item, a NUL-terminated ASCII string. This
information is intended for the user. This field is valid for
diff --git a/Documentation/media/uapi/v4l/vidioc-reqbufs.rst b/Documentation/media/uapi/v4l/vidioc-reqbufs.rst
index 5d0bc6d31c07..75dc34548ab7 100644
--- a/Documentation/media/uapi/v4l/vidioc-reqbufs.rst
+++ b/Documentation/media/uapi/v4l/vidioc-reqbufs.rst
@@ -107,7 +107,7 @@ any DMA in progress, an implicit
- __u32
- - ``reserved``\ [2]
+ - ``reserved``\ \[2\]
- A place holder for future extensions. Drivers and applications
must set the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
index 5fd332a5bfee..c96d2edbf72a 100644
--- a/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
@@ -150,7 +150,7 @@ error code is returned and no seek takes place.
- __u32
- - ``reserved``\ [5]
+ - ``reserved``\ \[5\]
- Reserved for future extensions. Applications must set the array to
zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst
index 0aa6482a91a6..f472ea27f9c0 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -132,7 +132,7 @@ multiple pads of the same sub-device is not defined.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst
index 7a5811b71b68..8fcbdc1e73fe 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst
@@ -142,7 +142,7 @@ information about try formats.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst
index bc0531eb56fa..3cb62dff3300 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -95,7 +95,7 @@ information about the try formats.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst b/Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst
index ae802f1594e7..7f39d38303e7 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst
@@ -109,7 +109,7 @@ modified format should be as close as possible to the original request.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst b/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
index 90e2a6635ebc..b7f2aca64422 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
@@ -113,7 +113,7 @@ should be as close as possible to the original request.
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst
index d8a1cabbd272..bcb1aae43e82 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst
@@ -95,7 +95,7 @@ the same sub-device is not defined.
- __u32
- - ``reserved``\ [9]
+ - ``reserved``\ \[9\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst b/Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst
index 50838a4a429e..7d6611f0f9d5 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst
@@ -117,7 +117,7 @@ Selection targets and flags are documented in
- __u32
- - ``reserved``\ [8]
+ - ``reserved``\ \[8\]
- Reserved for future extensions. Applications and drivers must set
the array to zero.
diff --git a/Documentation/media/uapi/v4l/vidioc-subscribe-event.rst b/Documentation/media/uapi/v4l/vidioc-subscribe-event.rst
index 3ed91c627702..7c00c93c2d95 100644
--- a/Documentation/media/uapi/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subscribe-event.rst
@@ -79,7 +79,7 @@ using the :ref:`VIDIOC_DQEVENT` ioctl.
- __u32
- - ``reserved``\ [5]
+ - ``reserved``\ \[5\]
- Reserved for future extensions. Drivers and applications must set
the array to zero.
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH 2/2] [media] docs-rst: escape [] characters
2016-07-13 11:15 ` [PATCH 2/2] [media] docs-rst: escape [] characters Mauro Carvalho Chehab
@ 2016-07-13 11:43 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-13 11:43 UTC (permalink / raw)
Cc: Linux Media Mailing List, Mauro Carvalho Chehab, Jonathan Corbet,
linux-doc
Em Wed, 13 Jul 2016 08:15:48 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> escreveu:
> Those characters are used for citations. Better to escape, to
> avoid them to be misinterpreted.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> ---
> diff --git a/Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf b/Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf
> index 765235e33a4de256a0b3fbf64ffe52946190cac4..f672b52ef683b3b6da4a43167f67ecbecfd6dc36 100644
> GIT binary patch
> delta 18
> ZcmaDX^HgR-AtP%{w54Ut<`TyDJOD)g2G9Ti
>
> delta 16
> XcmaDV^H^p>AtQ6NrRC-_#`in`I2#5S
>
This is clearly wrong. I'm nacking my own patch ;)
Thanks,
Mauro
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2016-07-13 11:44 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-07-13 11:15 [PATCH 1/2] [media] doc-rst: use the right markup for footnotes Mauro Carvalho Chehab
2016-07-13 11:15 ` [PATCH 2/2] [media] docs-rst: escape [] characters Mauro Carvalho Chehab
2016-07-13 11:43 ` Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).