Re: [PATCH 5/8] docs: dt: Group DT docs into relevant sub-sections
From: Mauro Carvalho Chehab
Date: Thu Mar 25 2021 - 13:53:44 EST
Em Thu, 25 Mar 2021 10:47:10 -0600
Rob Herring <robh@xxxxxxxxxx> escreveu:
> The DT docs are currently all just lumped together in the doc build.
> Let's organize the documents by kernel specifics, overlays and bindings.
>
> As writing-schema.rst is about bindings, let's move it to the bindings
> directory.
>
> Cc: Frank Rowand <frowand.list@xxxxxxxxx>
> Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> Signed-off-by: Rob Herring <robh@xxxxxxxxxx>
> ---
> Documentation/devicetree/bindings/index.rst | 7 ++-----
> .../devicetree/{ => bindings}/writing-schema.rst | 0
> Documentation/devicetree/index.rst | 16 ++++++++++++++--
> 3 files changed, 16 insertions(+), 7 deletions(-)
> rename Documentation/devicetree/{ => bindings}/writing-schema.rst (100%)
>
> diff --git a/Documentation/devicetree/bindings/index.rst b/Documentation/devicetree/bindings/index.rst
> index 3837b17c234f..d9002a3a0abb 100644
> --- a/Documentation/devicetree/bindings/index.rst
> +++ b/Documentation/devicetree/bindings/index.rst
> @@ -1,12 +1,9 @@
> .. SPDX-License-Identifier: GPL-2.0
>
> -===========
> -Device Tree
> -===========
> -
> .. toctree::
> :maxdepth: 1
>
> ABI
> - submitting-patches
> writing-bindings
> + writing-schema
> + submitting-patches
> diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
> similarity index 100%
> rename from Documentation/devicetree/writing-schema.rst
> rename to Documentation/devicetree/bindings/writing-schema.rst
> diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
> index 32509e8de8da..70b5dcdbcf07 100644
> --- a/Documentation/devicetree/index.rst
> +++ b/Documentation/devicetree/index.rst
> @@ -4,14 +4,26 @@
> Open Firmware and Devicetree
> =============================
>
> +Kernel Devicetree Usage
> +=======================
> .. toctree::
> :maxdepth: 1
>
> usage-model
> - writing-schema
> + of_unittest
> +
> +Devicetree Overlays
> +===================
> +.. toctree::
> + :maxdepth: 1
> +
> changesets
> dynamic-resolution-notes
> - of_unittest
> overlay-notes
>
> +Devicetree Bindings
> +===================
> +.. toctree::
> + :maxdepth: 1
> +
> bindings/index
Thanks,
Mauro