From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Rob Herring <robh@kernel.org>
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
Frank Rowand <frowand.list@gmail.com>,
Lee Jones <lee.jones@linaro.org>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH 5/8] docs: dt: Group DT docs into relevant sub-sections
Date: Thu, 25 Mar 2021 18:52:35 +0100 [thread overview]
Message-ID: <20210325185235.0e568bd3@coco.lan> (raw)
In-Reply-To: <20210325164713.1296407-6-robh@kernel.org>
Em Thu, 25 Mar 2021 10:47:10 -0600
Rob Herring <robh@kernel.org> 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@gmail.com>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
> 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
next prev parent reply other threads:[~2021-03-25 17:53 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-25 16:47 [PATCH 0/8] dt: doc build improvements and kerneldoc addition Rob Herring
2021-03-25 16:47 ` [PATCH 1/8] dt-bindings: Fix reference in submitting-patches.rst to the DT ABI doc Rob Herring
2021-03-25 17:51 ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 2/8] docs: dt: writing-schema: Remove spurious indentation Rob Herring
2021-03-25 17:51 ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 3/8] docs: dt: writing-schema: Include the example schema in the doc build Rob Herring
2021-03-25 17:52 ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 4/8] docs: dt: Make 'Devicetree' wording more consistent Rob Herring
2021-03-25 17:25 ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 5/8] docs: dt: Group DT docs into relevant sub-sections Rob Herring
2021-03-25 17:52 ` Mauro Carvalho Chehab [this message]
2021-03-25 16:47 ` [PATCH 6/8] of: Fix kerneldoc output formatting Rob Herring
2021-03-25 17:46 ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 7/8] of: Add missing 'Return' section in kerneldoc comments Rob Herring
2021-03-25 17:52 ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 8/8] docs: dt: Add DT API documentation Rob Herring
2021-03-25 17:53 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210325185235.0e568bd3@coco.lan \
--to=mchehab@kernel.org \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=frowand.list@gmail.com \
--cc=lee.jones@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=robh@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).