[media] docs-rst: better use the .. note:: tag
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 15 Aug 2016 20:49:50 +0000 (17:49 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 22 Aug 2016 13:02:29 +0000 (10:02 -0300)
Change multi-line note tags to be more symetric, e. g. not starting
the text together witht the tag.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
56 files changed:
Documentation/media/uapi/cec/cec-func-close.rst
Documentation/media/uapi/cec/cec-func-ioctl.rst
Documentation/media/uapi/cec/cec-func-open.rst
Documentation/media/uapi/cec/cec-func-poll.rst
Documentation/media/uapi/cec/cec-intro.rst
Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst
Documentation/media/uapi/cec/cec-ioc-adap-g-phys-addr.rst
Documentation/media/uapi/cec/cec-ioc-dqevent.rst
Documentation/media/uapi/cec/cec-ioc-g-mode.rst
Documentation/media/uapi/cec/cec-ioc-receive.rst
Documentation/media/uapi/dvb/dvb-fe-read-status.rst
Documentation/media/uapi/dvb/dvbapi.rst
Documentation/media/uapi/dvb/dvbproperty.rst
Documentation/media/uapi/dvb/examples.rst
Documentation/media/uapi/dvb/fe-get-info.rst
Documentation/media/uapi/dvb/fe-read-status.rst
Documentation/media/uapi/dvb/frontend.rst
Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst
Documentation/media/uapi/v4l/audio.rst
Documentation/media/uapi/v4l/buffer.rst
Documentation/media/uapi/v4l/crop.rst
Documentation/media/uapi/v4l/dev-codec.rst
Documentation/media/uapi/v4l/dev-osd.rst
Documentation/media/uapi/v4l/dev-overlay.rst
Documentation/media/uapi/v4l/dev-rds.rst
Documentation/media/uapi/v4l/extended-controls.rst
Documentation/media/uapi/v4l/func-mmap.rst
Documentation/media/uapi/v4l/pixfmt-006.rst
Documentation/media/uapi/v4l/pixfmt-007.rst
Documentation/media/uapi/v4l/pixfmt-sbggr16.rst
Documentation/media/uapi/v4l/pixfmt-y16-be.rst
Documentation/media/uapi/v4l/pixfmt-y16.rst
Documentation/media/uapi/v4l/standard.rst
Documentation/media/uapi/v4l/tuner.rst
Documentation/media/uapi/v4l/userp.rst
Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst
Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst
Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst
Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst
Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst
Documentation/media/uapi/v4l/vidioc-enumaudioout.rst
Documentation/media/uapi/v4l/vidioc-g-audioout.rst
Documentation/media/uapi/v4l/vidioc-g-edid.rst
Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst
Documentation/media/uapi/v4l/vidioc-g-modulator.rst
Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst
Documentation/media/uapi/v4l/vidioc-g-tuner.rst
Documentation/media/uapi/v4l/vidioc-qbuf.rst
Documentation/media/uapi/v4l/vidioc-query-dv-timings.rst
Documentation/media/uapi/v4l/vidioc-queryctrl.rst
Documentation/media/uapi/v4l/vidioc-querystd.rst
Documentation/media/uapi/v4l/vidioc-streamon.rst
Documentation/media/uapi/v4l/vidioc-subscribe-event.rst
Documentation/media/v4l-drivers/bttv.rst

index bb94e435891072f329e68d180a48bd8422839e27..bdbb9e545ae4c64a46f359a0a877da905d57de7f 100644 (file)
@@ -32,7 +32,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 Closes the cec device. Resources associated with the file descriptor are
index d0279e6d2734db1c8c7c1ce9b8b085f3b4ba5ffd..170bdd56211e5c5f6db4561eb069425a2357c113 100644 (file)
@@ -38,7 +38,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 The :c:func:`ioctl()` function manipulates cec device parameters. The
index 38fd7e0cfccd379ba332622a01dec59ab7764d84..c83989acfc83e198ab44ec4d064f462da83c2280 100644 (file)
@@ -45,7 +45,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 To open a cec device applications call :c:func:`open()` with the
index fcab65f6d6b8889f02eedc81ebc43a8727159475..5d1e0525056ee19b1e0e696e2c0addae50a1daa7 100644 (file)
@@ -29,7 +29,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 With the :c:func:`poll()` function applications can wait for CEC
index afa76f26fdde285f052a9e79c054ff594799c03d..4a19ea5323a97d6ac577b62caf015e6cf2653f63 100644 (file)
@@ -3,7 +3,9 @@
 Introduction
 ============
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 HDMI connectors provide a single pin for use by the Consumer Electronics
index eaedc63186e6f7088aea28020e1f5cd2e8365f71..2516d4c3a4c8da37cf911789d5fda133bec7e468 100644 (file)
@@ -31,7 +31,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 All cec devices must support :ref:`ioctl CEC_ADAP_G_CAPS <CEC_ADAP_G_CAPS>`. To query
index 04ee90099676b940608a499e84aaf38d571c0d48..359f7b3aa91acba5696960d724ea0f43fdb1927f 100644 (file)
@@ -35,7 +35,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 To query the current CEC logical addresses, applications call
index b955d044b3349cce8daca65f8f4d0e8d48870afa..c50aa3ee1e0dd76100b87d29aad8f2e992c524b3 100644 (file)
@@ -34,7 +34,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 To query the current physical address applications call
index 7a6d6d00ce194572f8053008397daa0395ee05dc..36eb4f907d3017e6bc635216a6f25c6c992b4634 100644 (file)
@@ -32,7 +32,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 CEC devices can send asynchronous events. These can be retrieved by
index f0084d892db67eeb3f5bbe2625063e97a3a4d134..c0e851f357d088a5aad24d18030c24753abbc320 100644 (file)
@@ -30,7 +30,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 By default any filehandle can use :ref:`CEC_TRANSMIT`, but in order to prevent
index ae5a39ade45ff588420bbd02c0325479f4dc82ff..7167a90209df8a4cb91cd5545aaffb6a485af61a 100644 (file)
@@ -33,7 +33,9 @@ Arguments
 Description
 ===========
 
-.. note:: This documents the proposed CEC API. This API is not yet finalized
+.. note::
+
+   This documents the proposed CEC API. This API is not yet finalized
    and is currently only available as a staging kernel module.
 
 To receive a CEC message the application has to fill in the
index fcffaa7e1463695e0703dcc64c0ca1261a1522ac..76c20612b274d03c02ad90d92fca65892da28bbf 100644 (file)
@@ -17,7 +17,9 @@ using :ref:`FE_READ_STATUS`.
 Signal statistics are provided via
 :ref:`FE_GET_PROPERTY`.
 
-.. note:: Most statistics require the demodulator to be fully locked
+.. note::
+
+   Most statistics require the demodulator to be fully locked
    (e. g. with FE_HAS_LOCK bit set). See
    :ref:`Frontend statistics indicators <frontend-stat-properties>` for
    more details.
index 48e61aba741e32a1cc4d4a501a5597143c1da264..37680137e3f276f0c5c3aec1b5b0ab63409ac91a 100644 (file)
@@ -8,7 +8,9 @@
 Part II - Digital TV API
 ########################
 
-.. note:: This API is also known as **DVB API**, although it is generic
+.. note::
+
+   This API is also known as **DVB API**, although it is generic
    enough to support all digital TV standards.
 
 **Version 5.10**
index cd0511b06c2c4842d762700afefeea2905469689..a5a859a4538109c2882159d87399aef85d75336a 100644 (file)
@@ -20,7 +20,9 @@ Also, the union didn't have any space left to be expanded without
 breaking userspace. So, the decision was to deprecate the legacy
 union/struct based approach, in favor of a properties set approach.
 
-.. note:: On Linux DVB API version 3, setting a frontend were done via
+.. note::
+
+   On Linux DVB API version 3, setting a frontend were done via
    :ref:`struct dvb_frontend_parameters <dvb-frontend-parameters>`.
    This got replaced on version 5 (also called "S2API", as this API were
    added originally_enabled to provide support for DVB-S2), because the
index bf0a8617de9244a4794f4e37c2d217c14ebb8a38..9a4ae4b0f3d784f2055a15d6fff33f72c147bc02 100644 (file)
@@ -9,7 +9,9 @@ Examples
 In this section we would like to present some examples for using the DVB
 API.
 
-..note:: This section is out of date, and the code below won't even
+..note::
+
+   This section is out of date, and the code below won't even
    compile. Please refer to the
    `libdvbv5 <https://linuxtv.org/docs/libdvbv5/index.html>`__ for
    updated/recommended examples.
index bb6c32e47ce8052a524acd4fb036534687ebcb21..dfc7644f9dac74be96f31902084111e6839c8206 100644 (file)
@@ -144,7 +144,9 @@ struct dvb_frontend_info
        -  Capabilities supported by the frontend
 
 
-.. note:: The frequencies are specified in Hz for Terrestrial and Cable
+.. note::
+
+   The frequencies are specified in Hz for Terrestrial and Cable
    systems. They're specified in kHz for Satellite systems
 
 
index 624ed9d06488e2e64caa6caaad800f9674537f93..defe30d036ec314715f5334bc14013dae3a6e52e 100644 (file)
@@ -40,7 +40,9 @@ used to check about the locking status of the frontend after being
 tuned. The ioctl takes a pointer to an integer where the status will be
 written.
 
-.. note:: The size of status is actually sizeof(enum fe_status), with
+.. note::
+
+   The size of status is actually sizeof(enum fe_status), with
    varies according with the architecture. This needs to be fixed in the
    future.
 
index 48c5cd487ce7601b37ea31183b9fe3b8900cfa1a..e051a90125400703ab390785b23ee34cc4def94c 100644 (file)
@@ -29,7 +29,9 @@ The frontend can be accessed through ``/dev/dvb/adapter?/frontend?``.
 Data types and ioctl definitions can be accessed by including
 ``linux/dvb/frontend.h`` in your application.
 
-.. note:: Transmission via the internet (DVB-IP) is not yet handled by this
+.. note::
+
+   Transmission via the internet (DVB-IP) is not yet handled by this
    API but a future extension is possible.
 
 On Satellite systems, the API support for the Satellite Equipment
index cffb01fd1042c594bf8e3c9fa9b6bcc15acf7bc4..b9d582fd7df1e3954d51e48d4d35de825ba310c5 100644 (file)
@@ -42,7 +42,9 @@ that prevents them to be used with some remotes. Wide band receiver might
 also be more precise. On the other hand its disadvantage it usually
 reduced range of reception.
 
-.. note:: Wide band receiver might be implictly enabled if you enable
+.. note::
+
+    Wide band receiver might be implictly enabled if you enable
     carrier reports. In that case it will be disabled as soon as you disable
     carrier reports. Trying to disable wide band receiver while carrier
     reports are active will do nothing.
index 4dd11345866c996d353ab2c575675dd904882315..b8059fb05372b9e7a72b0064eff28228840a64a1 100644 (file)
@@ -37,7 +37,9 @@ The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
 :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDOUT>` ioctls report the current
 audio input and output, respectively.
 
-.. note:: Note that, unlike :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+.. note::
+
+   Note that, unlike :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
    :ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a
    structure as :ref:`VIDIOC_ENUMAUDIO` and
    :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>` do, not just an index.
index 5deb4a46f99265d355be2b0c9a9b7e9bb1873fb6..f75f959b960b02d532039b883f2213dc1eb09504 100644 (file)
@@ -166,12 +166,15 @@ struct v4l2_buffer
          output device because the application did not pass new data in
          time.
 
-         .. note:: This may count the frames received e.g. over USB, without
+         .. note::
+
+            This may count the frames received e.g. over USB, without
             taking into account the frames dropped by the remote hardware due
             to limited compression throughput or bus bandwidth. These devices
             identify by not enumerating any video standards, see
             :ref:`standard`.
 
+
     -  .. row 10
 
        -  __u32
@@ -299,7 +302,9 @@ struct v4l2_plane
          ``bytesused`` will be set to the size of the plane (see the
          ``length`` field of this struct) by the driver.
 
-         .. note:: Note that the actual image data starts at ``data_offset``
+         .. note::
+
+            Note that the actual image data starts at ``data_offset``
             which may not be 0.
 
     -  .. row 2
@@ -371,7 +376,9 @@ struct v4l2_plane
          field when ``type`` refers to a capture stream, applications when
          it refers to an output stream.
 
-         .. note:: That data_offset is included  in ``bytesused``. So the
+         .. note::
+
+            That data_offset is included  in ``bytesused``. So the
             size of the image in the plane is ``bytesused``-``data_offset``
             at offset ``data_offset`` from the start of the plane.
 
index 0913822347af617e1d791993301c4ae246f41e2f..4622884b06ea41617040679a45f821797a660b62 100644 (file)
@@ -15,7 +15,9 @@ offset into a video signal.
 Applications can use the following API to select an area in the video
 signal, query the default area and the hardware limits.
 
-.. note:: Despite their name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
+.. note::
+
+   Despite their name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
    :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_S_CROP
    <VIDIOC_G_CROP>` ioctls apply to input as well as output devices.
 
@@ -38,7 +40,9 @@ support scaling or the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
 :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls. Their size (and position
 where applicable) will be fixed in this case.
 
-.. note:: All capture and output devices must support the
+.. note::
+
+   All capture and output devices must support the
    :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl such that applications
    can determine if scaling takes place.
 
@@ -144,7 +148,9 @@ reopening a device, such that piping data into or out of a device will
 work without special preparations. More advanced applications should
 ensure the parameters are suitable before starting I/O.
 
-.. note:: On the next two examples, a video capture device is assumed;
+.. note::
+
+   On the next two examples, a video capture device is assumed;
    change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
 
 Example: Resetting the cropping parameters
index dfb20328e34dbedb6194de56eeb61c322e8f21eb..d9f218449ddd3bf9f46530bf0e8e15e442681b55 100644 (file)
@@ -21,7 +21,9 @@ for both capture and output to start the codec.
 Video compression codecs use the MPEG controls to setup their codec
 parameters
 
-.. note:: The MPEG controls actually support many more codecs than
+.. note::
+
+   The MPEG controls actually support many more codecs than
    just MPEG. See :ref:`mpeg-controls`.
 
 Memory-to-memory devices can often be used as a shared resource: you can
index fadda131f02016b158bf20cfcd17a59f742ea576..4e1ee79ec3342ca26b53abc1e090a86bc8bae749 100644 (file)
@@ -16,7 +16,9 @@ this interface, which borrows structures and ioctls of the
 The OSD function is accessible through the same character special file
 as the :ref:`Video Output <capture>` function.
 
-.. note:: The default function of such a ``/dev/video`` device is video
+.. note::
+
+   The default function of such a ``/dev/video`` device is video
    capturing or output. The OSD function is only available after calling
    the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
 
index 92b4471b0c6e04d7a61b49acd38bc50241d81f70..d47a6bbc2e9802f4fcba1e8f9c6a3daf59d74905 100644 (file)
@@ -19,7 +19,9 @@ video into a window.
 Video overlay devices are accessed through the same character special
 files as :ref:`video capture <capture>` devices.
 
-.. note:: The default function of a ``/dev/video`` device is video
+.. note::
+
+   The default function of a ``/dev/video`` device is video
    capturing. The overlay function is only available after calling
    the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
 
@@ -236,7 +238,9 @@ exceeded are undefined. [#f3]_
     :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`,
     :ref:`framebuffer-flags`).
 
-    .. note:: This field was added in Linux 2.6.23, extending the
+    .. note::
+
+       This field was added in Linux 2.6.23, extending the
        structure. However the :ref:`VIDIOC_[G|S|TRY]_FMT <VIDIOC_G_FMT>`
        ioctls, which take a pointer to a :ref:`v4l2_format <v4l2-format>`
        parent structure with padding bytes at the end, are not affected.
index cd6ad63cb90b5b8e10959d2e6fb1ccabf0c19dc2..fa32538d4c1f8877aa354cc60edc296ba65f472f 100644 (file)
@@ -14,7 +14,9 @@ at devices capable of receiving and/or transmitting RDS information.
 For more information see the core RDS standard :ref:`iec62106` and the
 RBDS standard :ref:`nrsc4`.
 
-.. note:: Note that the RBDS standard as is used in the USA is almost
+.. note::
+
+   Note that the RBDS standard as is used in the USA is almost
    identical to the RDS standard. Any RDS decoder/encoder can also handle
    RBDS. Only some of the fields have slightly different meanings. See the
    RBDS standard for more information.
index 71071d73747d8cbd1e83c0fa7a6ce027425cae78..782f7f3c2209bc91f8f7e49a40fd51198132ca63 100644 (file)
@@ -184,7 +184,9 @@ Codec Control Reference
 Below all controls within the Codec control class are described. First
 the generic controls, then controls specific for certain hardware.
 
-.. note:: These controls are applicable to all codecs and not just MPEG. The
+.. note::
+
+   These controls are applicable to all codecs and not just MPEG. The
    defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG as the controls
    were originally made for MPEG codecs and later extended to cover all
    encoding formats.
index c156fb7b7422d6bdcc492ac345e72a81ff76d7e7..639fef5b4f781fc3334c2ef50958cbf61f360295 100644 (file)
@@ -78,7 +78,9 @@ Arguments
     ``MAP_SHARED`` allows applications to share the mapped memory with
     other (e. g. child-) processes.
 
-    .. note:: The Linux ``videobuf`` module  which is used by some
+    .. note::
+
+       The Linux ``videobuf`` module  which is used by some
        drivers supports only ``MAP_SHARED``. ``MAP_PRIVATE`` requests
        copy-on-write semantics. V4L2 applications should not set the
        ``MAP_PRIVATE``, ``MAP_DENYWRITE``, ``MAP_EXECUTABLE`` or ``MAP_ANON``
index 987b9a8a9eb4b2defae90c447c8074ffb4a19448..1c8321f9b1fb43b1449c2c1bb7e6f80142435fef 100644 (file)
@@ -19,7 +19,9 @@ colorspace field of struct :ref:`v4l2_pix_format <v4l2-pix-format>`
 or struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>`
 needs to be filled in.
 
-.. note:: The default R'G'B' quantization is full range for all
+.. note::
+
+   The default R'G'B' quantization is full range for all
    colorspaces except for BT.2020 which uses limited range R'G'B'
    quantization.
 
index 8c946b0c63a0b1593bb11e9c1f5adc4ae7c96d62..39753f6f7b8324484dc154872d44e953dee7a224 100644 (file)
@@ -538,7 +538,9 @@ projectors that use the DCI-P3 colorspace. The default transfer function
 is ``V4L2_XFER_FUNC_DCI_P3``. The default Y'CbCr encoding is
 ``V4L2_YCBCR_ENC_709``.
 
-.. note:: Note that this colorspace does not specify a
+.. note::
+
+   Note that this colorspace does not specify a
    Y'CbCr encoding since it is not meant to be encoded to Y'CbCr. So this
    default Y'CbCr encoding was picked because it is the HDTV encoding. The
    default Y'CbCr quantization is limited range. The chromaticities of the
@@ -754,7 +756,9 @@ reference are:
        -  0.316
 
 
-.. note:: This colorspace uses Illuminant C instead of D65 as the white
+.. note::
+
+   This colorspace uses Illuminant C instead of D65 as the white
    reference. To correctly convert an image in this colorspace to another
    that uses D65 you need to apply a chromatic adaptation algorithm such as
    the Bradford method.
@@ -888,7 +892,9 @@ reference are identical to sRGB. The transfer function use is
 with full range quantization where Y' is scaled to [0…255] and Cb/Cr are
 scaled to [-128…128] and then clipped to [-128…127].
 
-.. note:: The JPEG standard does not actually store colorspace
+.. note::
+
+   The JPEG standard does not actually store colorspace
    information. So if something other than sRGB is used, then the driver
    will have to set that information explicitly. Effectively
    ``V4L2_COLORSPACE_JPEG`` can be considered to be an abbreviation for
index 14446ed7f65049883d8959b4661aea779baa2882..7f295b48748c9913a4d6af5460506480ecaa6c8a 100644 (file)
@@ -19,7 +19,9 @@ This format is similar to
 has a depth of 16 bits. The least significant byte is stored at lower
 memory addresses (little-endian).
 
-..note:: The actual sampling precision may be lower than 16 bits,
+..note::
+
+    The actual sampling precision may be lower than 16 bits,
     for example 10 bits per pixel with values in tange 0 to 1023.
 
 **Byte Order.**
index 37fa099c16a603fe21091dfe19745d54fc692d79..b16874951f0f5fe40cfdcd70d9080bab8ea6d4db 100644 (file)
@@ -17,7 +17,9 @@ Description
 This is a grey-scale image with a depth of 16 bits per pixel. The most
 significant byte is stored at lower memory addresses (big-endian).
 
-.. note:: Tthe actual sampling precision may be lower than 16 bits, for
+.. note::
+
+   The actual sampling precision may be lower than 16 bits, for
    example 10 bits per pixel with values in range 0 to 1023.
 
 **Byte Order.**
index 4c41c042188b4497382b53366047b956d049242e..10e2824da147f5c654ba574abde9666b470b7af4 100644 (file)
@@ -17,7 +17,9 @@ Description
 This is a grey-scale image with a depth of 16 bits per pixel. The least
 significant byte is stored at lower memory addresses (little-endian).
 
-.. note:: The actual sampling precision may be lower than 16 bits, for
+.. note::
+
+   The actual sampling precision may be lower than 16 bits, for
    example 10 bits per pixel with values in range 0 to 1023.
 
 **Byte Order.**
index c4f678f545ec289b443a3bc73a5d8a7ce5749898..5dd341f18839cf29740f7b7802560113ff22af78 100644 (file)
@@ -41,7 +41,9 @@ output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
 *received* standard can be sensed with the
 :ref:`VIDIOC_QUERYSTD` ioctl.
 
-..note:: The parameter of all these ioctls is a pointer to a
+..note::
+
+   The parameter of all these ioctls is a pointer to a
    :ref:`v4l2_std_id <v4l2-std-id>` type (a standard set), *not* an
    index into the standard enumeration. Drivers must implement all video
    standard ioctls when the device has one or more video inputs or outputs.
index 37eb4b9b95fb4e25ee22db16aa22538300d27f46..c3df65c2e320088594b031f28207f6c332ee0e8b 100644 (file)
@@ -28,7 +28,9 @@ struct :ref:`v4l2_tuner <v4l2-tuner>` returned by :ref:`VIDIOC_G_TUNER <VIDIOC_G
 also contains signal status information applicable when the tuner of the
 current video or radio input is queried.
 
-.. note:: :ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` does not switch the
+.. note::
+
+   :ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` does not switch the
    current tuner, when there is more than one at all. The tuner is solely
    determined by the current video input. Drivers must support both ioctls
    and set the ``V4L2_CAP_TUNER`` flag in the struct :ref:`v4l2_capability
index 1d8b14bd4cdcd0357d91c40f8ef3ce46fb1ff425..0371e068c50b89dc2f25676a4dae28fe3c81ce77 100644 (file)
@@ -88,7 +88,9 @@ To start and stop capturing or output applications call the
 :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
 :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl.
 
-.. note:: ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` removes all buffers from
+.. note::
+
+   ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` removes all buffers from
    both queues and unlocks all buffers as a side effect. Since there is no
    notion of doing anything "now" on a multitasking system, if an
    application needs to synchronize with another event it should examine
index 6e05957013bb4bdeccf5c559f216ada32d8c43f6..c390412d5aa9d21cb2ffd2e0632e29b0e5377890 100644 (file)
@@ -39,7 +39,9 @@ initialize the ``pad`` field to 0, zero the reserved array of struct
 ``VIDIOC_DV_TIMINGS_CAP`` ioctl on a video node and the driver will fill
 in the structure.
 
-.. note:: Drivers may return different values after
+.. note::
+
+   Drivers may return different values after
    switching the video input or output.
 
 When implemented by the driver DV capabilities of subdevices can be
index 3ba75d3fb93c27179c7fd885779ea98547da5bd2..764d6cea601c5b9c0ca6dd0f60528f704b49e34a 100644 (file)
@@ -49,7 +49,9 @@ error code when the index is out of bounds. To enumerate all supported
 DV timings, applications shall begin at index zero, incrementing by one
 until the driver returns ``EINVAL``.
 
-.. note:: Drivers may enumerate a different set of DV timings after
+.. note::
+
+   Drivers may enumerate a different set of DV timings after
    switching the video input or output.
 
 When implemented by the driver DV timings of subdevices can be queried
index 90996f69d6ae7885e89084abddb7bd825e3118a2..4715261631ab01bbf03830551f7d03c35f82e538 100644 (file)
@@ -40,7 +40,9 @@ fill the rest of the structure or return an ``EINVAL`` error code. All
 formats are enumerable by beginning at index zero and incrementing by
 one until ``EINVAL`` is returned.
 
-.. note:: After switching input or output the list of enumerated image
+.. note::
+
+   After switching input or output the list of enumerated image
    formats may be different.
 
 
@@ -51,7 +53,6 @@ one until ``EINVAL`` is returned.
     :stub-columns: 0
     :widths:       1 1 2
 
-
     -  .. row 1
 
        -  __u32
@@ -113,7 +114,9 @@ one until ``EINVAL`` is returned.
          Several image formats are already defined by this specification in
          :ref:`pixfmt`.
 
-         .. attention:: These codes are not the same as those used
+         .. attention::
+
+            These codes are not the same as those used
             in the Windows world.
 
     -  .. row 7
index ceae6003039e114d67f983e9ce2ae378f9c14917..9c22a3a6938fdc16e1cdbc0820001cd2c408a9e3 100644 (file)
@@ -73,7 +73,9 @@ the device supports. Only for the ``V4L2_FRMIVAL_TYPE_DISCRETE`` type
 does it make sense to increase the index value to receive more frame
 intervals.
 
-.. note:: The order in which the frame intervals are returned has no
+.. note::
+
+   The order in which the frame intervals are returned has no
    special meaning. In particular does it not say anything about potential
    default frame intervals.
 
index 8b268354d44270cc9b419ca0164bcf8a7f68512c..6e2adf6c23a38ae4d75fe7b85b28f804fd54b8a5 100644 (file)
@@ -72,7 +72,9 @@ the ``type`` field to determine the type of frame size enumeration the
 device supports. Only for the ``V4L2_FRMSIZE_TYPE_DISCRETE`` type does
 it make sense to increase the index value to receive more frame sizes.
 
-.. note:: The order in which the frame sizes are returned has no special
+.. note::
+
+   The order in which the frame sizes are returned has no special
    meaning. In particular does it not say anything about potential default
    format sizes.
 
index 00ab5e19cc1d5d83609011302ffec71aadb23b16..ccf308bd9423a68231fd815659000d7c1c0d3fe1 100644 (file)
@@ -129,7 +129,9 @@ of the corresponding tuner/modulator is set.
        -  :cspan:`2` The supported modulation systems of this frequency
          band. See :ref:`band-modulation`.
 
-         .. note:: Currently only one modulation system per frequency band
+         .. note::
+
+            Currently only one modulation system per frequency band
             is supported. More work will need to be done if multiple
             modulation systems are possible. Contact the linux-media
             mailing list
index cde1db55834f96e69d7cf5becba53fc8914285c2..3112b43242f214d3c4d5c71d3c96e428a7336d55 100644 (file)
@@ -41,7 +41,9 @@ structure or return an ``EINVAL`` error code when the index is out of
 bounds. To enumerate all audio outputs applications shall begin at index
 zero, incrementing by one until the driver returns ``EINVAL``.
 
-.. note:: Connectors on a TV card to loop back the received audio signal
+.. note::
+
+    Connectors on a TV card to loop back the received audio signal
     to a sound card are not audio outputs in this sense.
 
 See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDOUT>` for a description of struct
index b1c1bfeb251e79ceefe8f259536ef6a9ca9426cc..c9e9a550e86d0bcd37e701ee914e02a1be5d31a8 100644 (file)
@@ -51,7 +51,9 @@ return the ``EINVAL`` error code when the index is out of bounds. This is a
 write-only ioctl, it does not return the current audio output attributes
 as ``VIDIOC_G_AUDOUT`` does.
 
-.. note:: Connectors on a TV card to loop back the received audio signal
+.. note::
+
+   Connectors on a TV card to loop back the received audio signal
    to a sound card are not audio outputs in this sense.
 
 
index 1a982b68a72f779f5563220af27963e5f1650c4f..b881098b89645a661045f6289a458970530af168 100644 (file)
@@ -67,7 +67,9 @@ total number of available EDID blocks and it will return 0 without
 copying any data. This is an easy way to discover how many EDID blocks
 there are.
 
-.. note:: If there are no EDID blocks available at all, then
+.. note::
+
+   If there are no EDID blocks available at all, then
    the driver will set ``blocks`` to 0 and it returns 0.
 
 To set the EDID blocks of a receiver the application has to fill in the
index 39e24ad4b825c7c2fc46c8c2c962db5ef403cc85..c91039b16d49ecba989fd72cb6dad840777511f3 100644 (file)
@@ -127,7 +127,9 @@ still cause this situation.
          to a value large enough to store the payload result and ``ENOSPC`` is
          returned.
 
-         .. note:: For string controls, this ``size`` field should
+         .. note::
+
+            For string controls, this ``size`` field should
             not be confused with the length of the string. This field refers
             to the size of the memory that contains the string. The actual
             *length* of the string may well be much smaller.
@@ -265,7 +267,9 @@ still cause this situation.
          control and ``V4L2_CTRL_WHICH_DEF_VAL`` will return the default
          value of the control.
 
-         .. note:: You can only get the default value of the control,
+         .. note::
+
+            You can only get the default value of the control,
             you cannot set or try it.
 
          For backwards compatibility you can also use a control class here
index a2e8c73f06786a5d701b3e38bc41d6ec0ee9392a..fcb2e4896d4d71fd5a6b000e616c91c3f9e0cfa1 100644 (file)
@@ -130,7 +130,9 @@ To change the radio frequency the
          shall be modulated. It contains a set of flags as defined in
          :ref:`modulator-txsubchans`.
 
-         .. note:: The tuner ``rxsubchans`` flags  are reused, but the
+         .. note::
+
+            The tuner ``rxsubchans`` flags  are reused, but the
             semantics are different. Video output devices
             are assumed to have an analog or PCM audio input with 1-3
             channels. The ``txsubchans`` flags select one or more channels
index f1f661d0200c7dacfeebbec73adea0948d4db7fc..f3db6f6776504ce6740a0cfaa89283e0356dfba7 100644 (file)
@@ -40,7 +40,9 @@ output device, applications initialize the ``type`` field of a struct
 driver fills in the remaining fields or returns an ``EINVAL`` error code if
 the sliced VBI API is unsupported or ``type`` is invalid.
 
-.. note:: The ``type`` field was added, and the ioctl changed from read-only
+.. note::
+
+   The ``type`` field was added, and the ioctl changed from read-only
    to write-read, in Linux 2.6.19.
 
 
index 614db06b8b4bc597e246a143e3440fb1feee74a7..d209736d6a536e8073e2aed0f121b374010bc84d 100644 (file)
@@ -391,7 +391,9 @@ To change the radio frequency the
          carrier for a monaural secondary language. Only
          ``V4L2_TUNER_ANALOG_TV`` tuners can have this capability.
 
-         .. note:: The ``V4L2_TUNER_CAP_LANG2`` and ``V4L2_TUNER_CAP_SAP``
+         .. note::
+
+            The ``V4L2_TUNER_CAP_LANG2`` and ``V4L2_TUNER_CAP_SAP``
             flags are synonyms. ``V4L2_TUNER_CAP_SAP`` applies when the tuner
             supports the ``V4L2_STD_NTSC_M`` video standard.
 
@@ -502,7 +504,9 @@ To change the radio frequency the
 
        -  The tuner receives a Second Audio Program.
 
-         .. note:: The ``V4L2_TUNER_SUB_LANG2`` and ``V4L2_TUNER_SUB_SAP``
+         .. note::
+
+            The ``V4L2_TUNER_SUB_LANG2`` and ``V4L2_TUNER_SUB_SAP``
             flags are synonyms. The ``V4L2_TUNER_SUB_SAP`` flag applies
             when the current video standard is ``V4L2_STD_NTSC_M``.
 
index 3b927f36fb5b07ff80980d90bee31b8307af3ccc..31c360d7d1a6f840b4fa965366a0046ac296669a 100644 (file)
@@ -137,7 +137,9 @@ EIO
     ``VIDIOC_DQBUF`` failed due to an internal error. Can also indicate
     temporary problems like signal loss.
 
-    .. note:: The driver might dequeue an (empty) buffer despite returning
+    .. note::
+
+       The driver might dequeue an (empty) buffer despite returning
        an error, or even stop capturing. Reusing such buffer may be unsafe
        though and its details (e.g. ``index``) may not be returned either.
        It is recommended that drivers indicate recoverable errors by setting
index 416d8d604af47075cb57799e47e702d5d5ee71fe..6a87f44cdf3f9d651b7ea5485e7670c7add76f9e 100644 (file)
@@ -39,7 +39,9 @@ similar to sensing the video standard. To do so, applications call
 :ref:`v4l2_dv_timings <v4l2-dv-timings>`. Once the hardware detects
 the timings, it will fill in the timings structure.
 
-.. note:: Drivers shall *not* switch timings automatically if new
+.. note::
+
+   Drivers shall *not* switch timings automatically if new
    timings are detected. Instead, drivers should send the
    ``V4L2_EVENT_SOURCE_CHANGE`` event (if they support this) and expect
    that userspace will take action by calling :ref:`VIDIOC_QUERY_DV_TIMINGS`.
index 8d6e61a7284dce4d06697801ad1f9d15a20f25b9..937ce9e32a7938822dd733ba40e2e9e91c4f9f4c 100644 (file)
@@ -84,7 +84,9 @@ fills the rest of the structure or returns an ``EINVAL`` error code when the
 :ref:`v4l2_queryctrl <v4l2-queryctrl>` ``minimum`` to ``maximum``,
 inclusive.
 
-.. note:: It is possible for ``VIDIOC_QUERYMENU`` to return
+.. note::
+
+   It is possible for ``VIDIOC_QUERYMENU`` to return
    an ``EINVAL`` error code for some indices between ``minimum`` and
    ``maximum``. In that case that particular menu item is not supported by
    this driver. Also note that the ``minimum`` value is not necessarily 0.
@@ -188,7 +190,9 @@ See also the examples in :ref:`control`.
          ``_BITMASK``, ``_MENU`` or ``_INTEGER_MENU`` control. Not valid
          for other types of controls.
 
-         .. note:: Drivers reset controls to their default value only when
+         .. note::
+
+            Drivers reset controls to their default value only when
             the driver is first loaded, never afterwards.
 
     -  .. row 8
@@ -306,7 +310,9 @@ See also the examples in :ref:`control`.
          ``_BOOLEAN``, ``_BITMASK``, ``_MENU``, ``_INTEGER_MENU``, ``_U8``
          or ``_U16`` control. Not valid for other types of controls.
 
-         .. note:: Drivers reset controls to their default value only when
+         .. note::
+
+            Drivers reset controls to their default value only when
             the driver is first loaded, never afterwards.
 
     -  .. row 8
@@ -728,7 +734,9 @@ See also the examples in :ref:`control`.
          case the hardware calculates the gain value based on the lighting
          conditions which can change over time.
 
-         .. note:: Setting a new value for a volatile control will have no
+         .. note::
+
+            Setting a new value for a volatile control will have no
             effect and no ``V4L2_EVENT_CTRL_CH_VALUE`` will be sent, unless
             the ``V4L2_CTRL_FLAG_EXECUTE_ON_WRITE`` flag (see below) is
             also set. Otherwise the new value will just be ignored.
index b4a4e222c7b0c1c9bc64f3c80a1f402dddd34360..cb03d249417cfc280ce7180959061fee427d40b5 100644 (file)
@@ -43,7 +43,9 @@ will return V4L2_STD_UNKNOWN. When detection is not possible or fails,
 the set must contain all standards supported by the current video input
 or output.
 
-.. note:: Drivers shall *not* switch the video standard
+.. note::
+
+   Drivers shall *not* switch the video standard
    automatically if a new video standard is detected. Instead, drivers
    should send the ``V4L2_EVENT_SOURCE_CHANGE`` event (if they support
    this) and expect that userspace will take action by calling
index bb23745ebcaf41ea331725a0c0a5d60104e9734c..7fa4362f9a81a5337bc13852655ae59d54e15baf 100644 (file)
@@ -76,7 +76,9 @@ then 0 is returned. Nothing happens in the case of ``VIDIOC_STREAMON``,
 but ``VIDIOC_STREAMOFF`` will return queued buffers to their starting
 state as mentioned above.
 
-.. note:: Applications can be preempted for unknown periods right before
+.. note::
+
+   Applications can be preempted for unknown periods right before
    or after the ``VIDIOC_STREAMON`` or ``VIDIOC_STREAMOFF`` calls, there is
    no notion of starting or stopping "now". Buffer timestamps can be used
    to synchronize with other events.
index 3f28e8c4796055de935b979d3f7a9aa5eacb7f98..86b16faa41bb1965cf2f04f851ee160dbff4f2d9 100644 (file)
@@ -54,7 +54,9 @@ using the :ref:`VIDIOC_DQEVENT` ioctl.
 
        -  Type of the event, see :ref:`event-type`.
 
-         .. note:: ``V4L2_EVENT_ALL`` can be used with
+         .. note::
+
+            ``V4L2_EVENT_ALL`` can be used with
             :ref:`VIDIOC_UNSUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>` for
             unsubscribing all events at once.
 
index f78c135b40e7d7831a2fc38032aa53c0f60d901a..7abc1c9a261bdaf151a68e46cc6a273ae44c73ad 100644 (file)
@@ -586,6 +586,7 @@ Cards
 -----
 
 .. note::
+
    For a more updated list, please check
    https://linuxtv.org/wiki/index.php/Hardware_Device_Information