From patchwork Fri Sep 25 06:51:56 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 255625 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.3 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 14DA5C4727E for ; Fri, 25 Sep 2020 06:52:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C76122311B for ; Fri, 25 Sep 2020 06:52:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601016725; bh=6xPjWQx4pdqPWhe57hN7t0TY4FqQaqlHz6FS3YcZ3GM=; h=From:To:Cc:Subject:Date:List-ID:From; b=Z+FWPNNjW8lQDNP+WPZ6hKGCa5hW9+MGTNYAjb+hR71OC2QiEiSRotURl4cL6S3v6 zXDXvAEnhDfr911a4ZUGRl5RjTncbCAkerMebDowyaovpArVylC+Si4kajtbh2ywd3 OcnE16/vRROpy7t9sGpzjcQHqhf0FXREdb3RW0LI= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727233AbgIYGwC (ORCPT ); Fri, 25 Sep 2020 02:52:02 -0400 Received: from mail.kernel.org ([198.145.29.99]:34756 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726983AbgIYGwC (ORCPT ); Fri, 25 Sep 2020 02:52:02 -0400 Received: from mail.kernel.org (ip5f5ad5bf.dynamic.kabel-deutschland.de [95.90.213.191]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 513BC21D91; Fri, 25 Sep 2020 06:52:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601016721; bh=6xPjWQx4pdqPWhe57hN7t0TY4FqQaqlHz6FS3YcZ3GM=; h=From:To:Cc:Subject:Date:From; b=l5Es0kVxSXLh5hpXELdE3Soy0XNuLthuknTRPhxeRK8vc4Dgm8KFgMZLw688+qikk x3Y67Vkm7fK/Mx283IoMxwHKRuROSLH8oupofKPN8i+I70d5jN+m6ozrT82WrvN8TR W7HPe27VXKL1xFSsbTofvO95jgbXZPe5DeBQ99es= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kLhaH-000RZE-Qq; Fri, 25 Sep 2020 08:51:57 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , linux-media@vger.kernel.org Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org Subject: [PATCH] media: glossary.rst: use the right case for glossary entries Date: Fri, 25 Sep 2020 08:51:56 +0200 Message-Id: <8aa69e13e14d3c687721b64780b03ad5dd59af78.1601016714.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org 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 --- .../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 ` that + A group of :term:`hardware components ` that together make a larger user-facing functional peripheral. For - instance, the :term:`SoC` :term:`ISP` :term:`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.