ich777/linux_media
1
0
Fork 0
mirror of https://github.com/tbsdtv/linux_media.git synced 2025-07-23 20:51:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

media: glossary.rst: use the right case for glossary entries

Browse Source 
Sphinx 3.x is pedantic with glossary entries:

    Documentation/userspace-api/media/glossary.rst:17: WARNING: term device driver not found in case sensitive match.made a reference to Device Driver instead.
    Documentation/userspace-api/media/glossary.rst:59: WARNING: term media hardware not found in case sensitive match.made a reference to Media Hardware instead.
    Documentation/userspace-api/media/glossary.rst:59: WARNING: term IP block not found in case sensitive match.made a reference to IP Block instead.
    Documentation/userspace-api/media/glossary.rst:64: WARNING: term hardware component not found in case sensitive match.made a reference to Hardware Component instead.
    Documentation/userspace-api/media/glossary.rst:64: WARNING: term ip block not found in case sensitive match.made a reference to IP Block instead.
    Documentation/userspace-api/media/glossary.rst:70: WARNING: term peripheral not found in case sensitive match.made a reference to Peripheral instead.
    Documentation/userspace-api/media/glossary.rst:130: WARNING: term V4L2 hardware not found in case sensitive match.made a reference to V4L2 Hardware instead.
    Documentation/userspace-api/media/glossary.rst:151: WARNING: term hardware peripheral not found in case sensitive match.made a reference to Hardware Peripheral instead.
    Documentation/userspace-api/media/glossary.rst:183: WARNING: term device node not found in case sensitive match.made a reference to Device Node instead.
    Documentation/userspace-api/media/glossary.rst:191: WARNING: term bridge driver not found in case sensitive match.made a reference to Bridge Driver instead.

While it works with case-insensitive entires, it complains.

Let's fix it, in order to cleanup the warnings. Also, I won't
doubt that a later change on Sphinx will end breaking support
for it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab
2020-09-25 08:48:32 +02:00
parent 6fcadfc727
commit 1c16b00901
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/userspace-api/media/glossary.rst
View File

@@ -14,7 +14,7 @@ Glossary
.. glossary:: .. glossary::
Bridge Driver Bridge Driver
A :term:`device driver` that implements the main logic to talk with A :term:`Device Driver` that implements the main logic to talk with
media hardware. media hardware.
CEC API CEC API
@@ -56,18 +56,18 @@ Glossary
See https://en.wikipedia.org/wiki/Field-programmable_gate_array. See https://en.wikipedia.org/wiki/Field-programmable_gate_array.
Hardware Component Hardware Component
A subset of the :term:`media hardware`. For example an :term:`I²C` or A subset of the :term:`Media Hardware`. For example an :term:`I²C` or
:term:`SPI` device, or an :term:`IP block` inside an :term:`SPI` device, or an :term:`IP Block` inside an
:term:`SoC` or :term:`FPGA`. :term:`SoC` or :term:`FPGA`.
Hardware Peripheral Hardware Peripheral
A group of :term:`hardware components <hardware component>` that A group of :term:`hardware components <Hardware Component>` that
together make a larger user-facing functional peripheral. For together make a larger user-facing functional peripheral. For
instance, the :term:`SoC` :term:`ISP` :term:`IP block <ip block>` instance, the :term:`SoC` :term:`ISP` :term:`IP Block`
and the external camera sensors together make a camera hardware and the external camera sensors together make a camera hardware
peripheral. peripheral.
Also known as :term:`peripheral`. Also known as :term:`Peripheral`.
I²C I²C
**Inter-Integrated Circuit** **Inter-Integrated Circuit**
@@ -127,7 +127,7 @@ Glossary
See :ref:`media_controller`. See :ref:`media_controller`.
MC-centric MC-centric
:term:`V4L2 hardware` device driver that requires :term:`MC API`. :term:`V4L2 Hardware` device driver that requires :term:`MC API`.
Such drivers have ``V4L2_CAP_IO_MC`` device_caps field set Such drivers have ``V4L2_CAP_IO_MC`` device_caps field set
(see :ref:`VIDIOC_QUERYCAP`). (see :ref:`VIDIOC_QUERYCAP`).
@@ -148,7 +148,7 @@ Glossary
instructions on a single integrated circuit. instructions on a single integrated circuit.
Peripheral Peripheral
The same as :term:`hardware peripheral`. The same as :term:`Hardware Peripheral`.
RC API RC API
**Remote Controller API** **Remote Controller API**
@@ -180,7 +180,7 @@ Glossary
control a V4L2 hardware. control a V4L2 hardware.
V4L2 Device Node V4L2 Device Node
A :term:`device node` that is associated to a V4L driver. A :term:`Device Node` that is associated to a V4L driver.
The V4L2 device node naming is specified at :ref:`v4l2_device_naming`. The V4L2 device node naming is specified at :ref:`v4l2_device_naming`.
@@ -189,7 +189,7 @@ Glossary
V4L2 Sub-device V4L2 Sub-device
V4L2 hardware components that aren't controlled by a V4L2 hardware components that aren't controlled by a
:term:`bridge driver`. See :ref:`subdev`. :term:`Bridge Driver`. See :ref:`subdev`.
Video-node-centric Video-node-centric
V4L2 device driver that doesn't require a media controller to be used. V4L2 device driver that doesn't require a media controller to be used.