lkml.org 
[lkml]   [2020]   [Sep]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 2/9] media: glossary.rst: use the right case for glossary entries
    Date
    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>
    ---
    .../userspace-api/media/glossary.rst | 20 +++++++++----------
    1 file changed, 10 insertions(+), 10 deletions(-)

    diff --git a/Documentation/userspace-api/media/glossary.rst b/Documentation/userspace-api/media/glossary.rst
    index 59a95dba5909..cb165d7176b7 100644
    --- a/Documentation/userspace-api/media/glossary.rst
    +++ b/Documentation/userspace-api/media/glossary.rst
    @@ -14,7 +14,7 @@ Glossary
    .. glossary::

    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.

    CEC API
    @@ -56,18 +56,18 @@ Glossary
    See https://en.wikipedia.org/wiki/Field-programmable_gate_array.

    Hardware Component
    - A subset of the :term:`media hardware`. For example an :term:`I²C` or
    - :term:`SPI` device, or an :term:`IP block` inside an
    + 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:`SoC` or :term:`FPGA`.

    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
    - 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
    peripheral.

    - Also known as :term:`peripheral`.
    + Also known as :term:`Peripheral`.

    I²C
    **Inter-Integrated Circuit**
    @@ -127,7 +127,7 @@ Glossary
    See :ref:`media_controller`.

    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
    (see :ref:`VIDIOC_QUERYCAP`).
    @@ -148,7 +148,7 @@ Glossary
    instructions on a single integrated circuit.

    Peripheral
    - The same as :term:`hardware peripheral`.
    + The same as :term:`Hardware Peripheral`.

    RC API
    **Remote Controller API**
    @@ -180,7 +180,7 @@ Glossary
    control a V4L2 hardware.

    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`.

    @@ -189,7 +189,7 @@ Glossary

    V4L2 Sub-device
    V4L2 hardware components that aren't controlled by a
    - :term:`bridge driver`. See :ref:`subdev`.
    + :term:`Bridge Driver`. See :ref:`subdev`.

    Video-node-centric
    V4L2 device driver that doesn't require a media controller to be used.
    --
    2.26.2
    \
     
     \ /
      Last update: 2020-09-30 08:36    [W:2.824 / U:0.996 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site