linux-kernel - Re: [PATCH 4/8] docs: dt: Make 'Devicetree' wording more consistent

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20210325182506.184d251b@coco.lan>
Date:   Thu, 25 Mar 2021 18:25:06 +0100
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Rob Herring <robh@...nel.org>
Cc:     devicetree@...r.kernel.org, linux-kernel@...r.kernel.org,
        Frank Rowand <frowand.list@...il.com>,
        Lee Jones <lee.jones@...aro.org>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Subject: Re: [PATCH 4/8] docs: dt: Make 'Devicetree' wording more consistent

Em Thu, 25 Mar 2021 10:47:09 -0600
Rob Herring <robh@...nel.org> escreveu:

> There's a variety of ways 'Devicetree' has been written. This is most
> evident in the documentation build contents where we have 'Device Tree',
> 'DeviceTree', etc. The DT spec has somewhat standardized on
> 'Devicetree', so let's use that.
> 
> Cc: Frank Rowand <frowand.list@...il.com>
> Cc: Mauro Carvalho Chehab <mchehab@...nel.org>
> Signed-off-by: Rob Herring <robh@...nel.org>
> ---
>  Documentation/devicetree/bindings/submitting-patches.rst | 2 +-
>  Documentation/devicetree/changesets.rst                  | 8 ++++----
>  Documentation/devicetree/dynamic-resolution-notes.rst    | 8 ++++----
>  Documentation/devicetree/index.rst                       | 2 +-
>  Documentation/devicetree/of_unittest.rst                 | 6 +++---
>  Documentation/devicetree/overlay-notes.rst               | 8 ++++----
>  Documentation/devicetree/usage-model.rst                 | 8 ++++----
>  Documentation/devicetree/writing-schema.rst              | 2 +-
>  8 files changed, 22 insertions(+), 22 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
> index 42e86f978be2..51c459909575 100644
> --- a/Documentation/devicetree/bindings/submitting-patches.rst
> +++ b/Documentation/devicetree/bindings/submitting-patches.rst
> @@ -1,7 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
>  ==========================================
> -Submitting devicetree (DT) binding patches
> +Submitting Devicetree (DT) binding patches
>  ==========================================
>  
>  I. For patch submitters
> diff --git a/Documentation/devicetree/changesets.rst b/Documentation/devicetree/changesets.rst
> index c7fd8cd6a270..2091468d4837 100644
> --- a/Documentation/devicetree/changesets.rst
> +++ b/Documentation/devicetree/changesets.rst
> @@ -1,10 +1,10 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -=============
> -DT Changesets
> -=============
> +=====================
> +Devicetree Changesets
> +=====================
>  
> -A DT changeset is a method which allows one to apply changes
> +A Devicetree changeset is a method which allows one to apply changes
>  in the live tree in such a way that either the full set of changes
>  will be applied, or none of them will be. If an error occurs partway
>  through applying the changeset, then the tree will be rolled back to the
> diff --git a/Documentation/devicetree/dynamic-resolution-notes.rst b/Documentation/devicetree/dynamic-resolution-notes.rst
> index 570b7e1f39eb..f81ad8daa36f 100644
> --- a/Documentation/devicetree/dynamic-resolution-notes.rst
> +++ b/Documentation/devicetree/dynamic-resolution-notes.rst
> @@ -1,11 +1,11 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -==================================
> -Device Tree Dynamic Resolver Notes
> -==================================
> +=================================
> +Devicetree Dynamic Resolver Notes
> +=================================
>  
>  This document describes the implementation of the in-kernel
> -Device Tree resolver, residing in drivers/of/resolver.c
> +DeviceTree resolver, residing in drivers/of/resolver.c

DeviceTree -> Devicetree.

The rest looks ok to me.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

>  
>  How the resolver works
>  ----------------------
> diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
> index 54026763916d..32509e8de8da 100644
> --- a/Documentation/devicetree/index.rst
> +++ b/Documentation/devicetree/index.rst
> @@ -1,7 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
>  =============================
> -Open Firmware and Device Tree
> +Open Firmware and Devicetree
>  =============================
>  
>  .. toctree::
> diff --git a/Documentation/devicetree/of_unittest.rst b/Documentation/devicetree/of_unittest.rst
> index dea05214f3ad..2afe41a37148 100644
> --- a/Documentation/devicetree/of_unittest.rst
> +++ b/Documentation/devicetree/of_unittest.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -==================================
> -Open Firmware Device Tree Unittest
> -==================================
> +=================================
> +Open Firmware Devicetree Unittest
> +=================================
>  
>  Author: Gaurav Minocha <gaurav.minocha.os@...il.com>
>  
> diff --git a/Documentation/devicetree/overlay-notes.rst b/Documentation/devicetree/overlay-notes.rst
> index c67cc676bbd2..b2b8db765b8c 100644
> --- a/Documentation/devicetree/overlay-notes.rst
> +++ b/Documentation/devicetree/overlay-notes.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -=========================
> -Device Tree Overlay Notes
> -=========================
> +========================
> +Devicetree Overlay Notes
> +========================
>  
>  This document describes the implementation of the in-kernel
>  device tree overlay functionality residing in drivers/of/overlay.c and is a
> @@ -11,7 +11,7 @@ companion document to Documentation/devicetree/dynamic-resolution-notes.rst[1]
>  How overlays work
>  -----------------
>  
> -A Device Tree's overlay purpose is to modify the kernel's live tree, and
> +A Devicetree's overlay purpose is to modify the kernel's live tree, and
>  have the modification affecting the state of the kernel in a way that
>  is reflecting the changes.
>  Since the kernel mainly deals with devices, any new device node that result
> diff --git a/Documentation/devicetree/usage-model.rst b/Documentation/devicetree/usage-model.rst
> index 1eb83496ca1e..b6a287955ee5 100644
> --- a/Documentation/devicetree/usage-model.rst
> +++ b/Documentation/devicetree/usage-model.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -=========================
> -Linux and the Device Tree
> -=========================
> +========================
> +Linux and the Devicetree
> +========================
>  
>  The Linux usage model for device tree data
>  
> @@ -14,7 +14,7 @@ at devicetree.org\ [1]_.
>  
>  .. [1] https://www.devicetree.org/specifications/
>  
> -The "Open Firmware Device Tree", or simply Device Tree (DT), is a data
> +The "Open Firmware Device Tree", or simply Devicetree (DT), is a data
>  structure and language for describing hardware.  More specifically, it
>  is a description of hardware that is readable by an operating system
>  so that the operating system doesn't need to hard code details of the
> diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/writing-schema.rst
> index be14dbed6081..23d6579aea2c 100644
> --- a/Documentation/devicetree/writing-schema.rst
> +++ b/Documentation/devicetree/writing-schema.rst
> @@ -1,6 +1,6 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -Writing DeviceTree Bindings in json-schema
> +Writing Devicetree Bindings in json-schema
>  ==========================================
>  
>  Devicetree bindings are written using json-schema vocabulary. Schema files are



Thanks,
Mauro