While most of the devicetree stuff has its own format (with is now being
converted to YAML format), some documents there are actually
describing the DT concepts and how to contribute to it.
IMHO, those documents would fit perfectly as part of the documentation
body, as part of the firmare documents set.
This patch series manually converts some DT documents that, on my
opinion, would belong to it.
If you want to see how this would show at the documentation body,
a sneak peak of this series (together with the other pending
doc patches from me) is available at:
https://www.infradead.org/~mchehab/kernel_docs/devicetree/index.html
This series is available on this devel branch:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=dt-docs-20200228
and it is based on next-20200228
-
v2: Fixed my email address and removed extra wrong SoB on all patches.
Mauro Carvalho Chehab (12):
docs: dt: add an index.rst file for devicetree
docs: dt: convert usage-model.txt to ReST
docs: dt: usage_model.rst: fix link for DT usage
docs: dt: convert booting-without-of.txt to ReST format
docs: dt: convert changesets to ReST
docs: dt: convert dynamic-resolution-notes.txt to ReST
docs: dt: convert of_unittest.txt to ReST
docs: dt: convert overlay-notes.txt to ReST format
docs: dt: minor adjustments at writing-schema.rst
docs: dt: convert ABI.txt to ReST format
docs: dt: convert submitting-patches.txt to ReST format
docs: dt: convert writing-bindings.txt to ReST
Documentation/arm/booting.rst | 2 +-
Documentation/arm/microchip.rst | 2 +-
.../devicetree/bindings/{ABI.txt => ABI.rst} | 5 +-
.../devicetree/bindings/arm/amlogic.yaml | 2 +-
.../devicetree/bindings/arm/syna.txt | 2 +-
Documentation/devicetree/bindings/index.rst | 12 +
...ing-patches.txt => submitting-patches.rst} | 12 +-
...ting-bindings.txt => writing-bindings.rst} | 9 +-
...-without-of.txt => booting-without-of.rst} | 299 ++++++++++--------
.../{changesets.txt => changesets.rst} | 24 +-
...notes.txt => dynamic-resolution-notes.rst} | 5 +-
Documentation/devicetree/index.rst | 18 ++
.../{of_unittest.txt => of_unittest.rst} | 186 +++++------
.../{overlay-notes.txt => overlay-notes.rst} | 143 +++++----
.../{usage-model.txt => usage-model.rst} | 35 +-
Documentation/devicetree/writing-schema.rst | 9 +-
Documentation/index.rst | 3 +
Documentation/process/submitting-patches.rst | 2 +-
.../it_IT/process/submitting-patches.rst | 2 +-
Documentation/translations/zh_CN/arm/Booting | 2 +-
MAINTAINERS | 4 +-
include/linux/mfd/core.h | 2 +-
scripts/checkpatch.pl | 2 +-
23 files changed, 446 insertions(+), 336 deletions(-)
rename Documentation/devicetree/bindings/{ABI.txt => ABI.rst} (94%)
create mode 100644 Documentation/devicetree/bindings/index.rst
rename Documentation/devicetree/bindings/{submitting-patches.txt => submitting-patches.rst} (92%)
rename Documentation/devicetree/bindings/{writing-bindings.txt => writing-bindings.rst} (89%)
rename Documentation/devicetree/{booting-without-of.txt => booting-without-of.rst} (90%)
rename Documentation/devicetree/{changesets.txt => changesets.rst} (59%)
rename Documentation/devicetree/{dynamic-resolution-notes.txt => dynamic-resolution-notes.rst} (90%)
create mode 100644 Documentation/devicetree/index.rst
rename Documentation/devicetree/{of_unittest.txt => of_unittest.rst} (54%)
rename Documentation/devicetree/{overlay-notes.txt => overlay-notes.rst} (56%)
rename Documentation/devicetree/{usage-model.txt => usage-model.rst} (97%)
--
2.21.1
The devicetree.org doesn't host the Device_Tree_Usage page
anymore. So, fix the link to point to a new address.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/devicetree/usage-model.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/devicetree/usage-model.rst b/Documentation/devicetree/usage-model.rst
index 326d7af10c5b..e1b42dc63f01 100644
--- a/Documentation/devicetree/usage-model.rst
+++ b/Documentation/devicetree/usage-model.rst
@@ -12,7 +12,7 @@ This article describes how Linux uses the device tree. An overview of
the device tree data format can be found on the device tree usage page
at devicetree.org\ [1]_.
-.. [1] http://devicetree.org/Device_Tree_Usage
+.. [1] https://elinux.org/Device_Tree_Usage
The "Open Firmware Device Tree", or simply Device Tree (DT), is a data
structure and language for describing hardware. More specifically, it
--
2.21.1
- Add a SPDX header;
- Adjust document title;
- Add it to devicetree/index.rst.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
...mic-resolution-notes.txt => dynamic-resolution-notes.rst} | 5 ++++-
Documentation/devicetree/index.rst | 1 +
Documentation/devicetree/overlay-notes.txt | 2 +-
MAINTAINERS | 2 +-
4 files changed, 7 insertions(+), 3 deletions(-)
rename Documentation/devicetree/{dynamic-resolution-notes.txt => dynamic-resolution-notes.rst} (90%)
diff --git a/Documentation/devicetree/dynamic-resolution-notes.txt b/Documentation/devicetree/dynamic-resolution-notes.rst
similarity index 90%
rename from Documentation/devicetree/dynamic-resolution-notes.txt
rename to Documentation/devicetree/dynamic-resolution-notes.rst
index c24ec366c5dc..570b7e1f39eb 100644
--- a/Documentation/devicetree/dynamic-resolution-notes.txt
+++ b/Documentation/devicetree/dynamic-resolution-notes.rst
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==================================
Device Tree Dynamic Resolver Notes
-----------------------------------
+==================================
This document describes the implementation of the in-kernel
Device Tree resolver, residing in drivers/of/resolver.c
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index 64c78c3ffea6..308cac9d7021 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -11,3 +11,4 @@ Open Firmware and Device Tree
writing-schema
booting-without-of
changesets
+ dynamic-resolution-notes
diff --git a/Documentation/devicetree/overlay-notes.txt b/Documentation/devicetree/overlay-notes.txt
index 725fb8d255c1..3f20a39e4bc2 100644
--- a/Documentation/devicetree/overlay-notes.txt
+++ b/Documentation/devicetree/overlay-notes.txt
@@ -3,7 +3,7 @@ Device Tree Overlay Notes
This document describes the implementation of the in-kernel
device tree overlay functionality residing in drivers/of/overlay.c and is a
-companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1]
+companion document to Documentation/devicetree/dynamic-resolution-notes.rst[1]
How overlays work
-----------------
diff --git a/MAINTAINERS b/MAINTAINERS
index 09b04505e7c3..1380b1ed69a2 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12458,7 +12458,7 @@ M: Pantelis Antoniou <[email protected]>
M: Frank Rowand <[email protected]>
L: [email protected]
S: Maintained
-F: Documentation/devicetree/dynamic-resolution-notes.txt
+F: Documentation/devicetree/dynamic-resolution-notes.rst
F: Documentation/devicetree/overlay-notes.txt
F: drivers/of/overlay.c
F: drivers/of/resolver.c
--
2.21.1
On Mon, 2 Mar 2020 08:59:25 +0100
Mauro Carvalho Chehab <[email protected]> wrote:
> While most of the devicetree stuff has its own format (with is now being
> converted to YAML format), some documents there are actually
> describing the DT concepts and how to contribute to it.
>
> IMHO, those documents would fit perfectly as part of the documentation
> body, as part of the firmare documents set.
>
> This patch series manually converts some DT documents that, on my
> opinion, would belong to it.
Did you consider putting this stuff into the firmware-guide while you were
at it? It's not a perfect fit, I guess, but it doesn't seem too awkward
either.
It also seems like it would be good to CC the devicetree folks, or at
least the devicetree mailing list?
Thanks,
jon
Hi Mauro,
On 3/2/20 1:59 AM, Mauro Carvalho Chehab wrote:
> While most of the devicetree stuff has its own format (with is now being
> converted to YAML format), some documents there are actually
> describing the DT concepts and how to contribute to it.
>
> IMHO, those documents would fit perfectly as part of the documentation
> body, as part of the firmare documents set.
>
> This patch series manually converts some DT documents that, on my
> opinion, would belong to it.
>
> If you want to see how this would show at the documentation body,
> a sneak peak of this series (together with the other pending
> doc patches from me) is available at:
>
> https://www.infradead.org/~mchehab/kernel_docs/devicetree/index.html
>
> This series is available on this devel branch:
>
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=dt-docs-20200228
>
> and it is based on next-20200228
Thanks for doing all of this work! It llooks nice.
-Frank
>
> -
>
> v2: Fixed my email address and removed extra wrong SoB on all patches.
>
>
> Mauro Carvalho Chehab (12):
> docs: dt: add an index.rst file for devicetree
> docs: dt: convert usage-model.txt to ReST
> docs: dt: usage_model.rst: fix link for DT usage
> docs: dt: convert booting-without-of.txt to ReST format
> docs: dt: convert changesets to ReST
> docs: dt: convert dynamic-resolution-notes.txt to ReST
> docs: dt: convert of_unittest.txt to ReST
> docs: dt: convert overlay-notes.txt to ReST format
> docs: dt: minor adjustments at writing-schema.rst
> docs: dt: convert ABI.txt to ReST format
> docs: dt: convert submitting-patches.txt to ReST format
> docs: dt: convert writing-bindings.txt to ReST
>
> Documentation/arm/booting.rst | 2 +-
> Documentation/arm/microchip.rst | 2 +-
> .../devicetree/bindings/{ABI.txt => ABI.rst} | 5 +-
> .../devicetree/bindings/arm/amlogic.yaml | 2 +-
> .../devicetree/bindings/arm/syna.txt | 2 +-
> Documentation/devicetree/bindings/index.rst | 12 +
> ...ing-patches.txt => submitting-patches.rst} | 12 +-
> ...ting-bindings.txt => writing-bindings.rst} | 9 +-
> ...-without-of.txt => booting-without-of.rst} | 299 ++++++++++--------
> .../{changesets.txt => changesets.rst} | 24 +-
> ...notes.txt => dynamic-resolution-notes.rst} | 5 +-
> Documentation/devicetree/index.rst | 18 ++
> .../{of_unittest.txt => of_unittest.rst} | 186 +++++------
> .../{overlay-notes.txt => overlay-notes.rst} | 143 +++++----
> .../{usage-model.txt => usage-model.rst} | 35 +-
> Documentation/devicetree/writing-schema.rst | 9 +-
> Documentation/index.rst | 3 +
> Documentation/process/submitting-patches.rst | 2 +-
> .../it_IT/process/submitting-patches.rst | 2 +-
> Documentation/translations/zh_CN/arm/Booting | 2 +-
> MAINTAINERS | 4 +-
> include/linux/mfd/core.h | 2 +-
> scripts/checkpatch.pl | 2 +-
> 23 files changed, 446 insertions(+), 336 deletions(-)
> rename Documentation/devicetree/bindings/{ABI.txt => ABI.rst} (94%)
> create mode 100644 Documentation/devicetree/bindings/index.rst
> rename Documentation/devicetree/bindings/{submitting-patches.txt => submitting-patches.rst} (92%)
> rename Documentation/devicetree/bindings/{writing-bindings.txt => writing-bindings.rst} (89%)
> rename Documentation/devicetree/{booting-without-of.txt => booting-without-of.rst} (90%)
> rename Documentation/devicetree/{changesets.txt => changesets.rst} (59%)
> rename Documentation/devicetree/{dynamic-resolution-notes.txt => dynamic-resolution-notes.rst} (90%)
> create mode 100644 Documentation/devicetree/index.rst
> rename Documentation/devicetree/{of_unittest.txt => of_unittest.rst} (54%)
> rename Documentation/devicetree/{overlay-notes.txt => overlay-notes.rst} (56%)
> rename Documentation/devicetree/{usage-model.txt => usage-model.rst} (97%)
>
On 3/2/20 1:59 AM, Mauro Carvalho Chehab wrote:
> The devicetree.org doesn't host the Device_Tree_Usage page
> anymore. So, fix the link to point to a new address.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/devicetree/usage-model.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/devicetree/usage-model.rst b/Documentation/devicetree/usage-model.rst
> index 326d7af10c5b..e1b42dc63f01 100644
> --- a/Documentation/devicetree/usage-model.rst
> +++ b/Documentation/devicetree/usage-model.rst
> @@ -12,7 +12,7 @@ This article describes how Linux uses the device tree. An overview of
> the device tree data format can be found on the device tree usage page
> at devicetree.org\ [1]_.
s/devicetree.org/elinux.org/
>
> -.. [1] http://devicetree.org/Device_Tree_Usage
> +.. [1] https://elinux.org/Device_Tree_Usage
>
> The "Open Firmware Device Tree", or simply Device Tree (DT), is a data
> structure and language for describing hardware. More specifically, it
>
On Mon, Mar 2, 2020 at 3:11 PM Frank Rowand <[email protected]> wrote:
>
> On 3/2/20 1:59 AM, Mauro Carvalho Chehab wrote:
> > The devicetree.org doesn't host the Device_Tree_Usage page
> > anymore. So, fix the link to point to a new address.
> >
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> > ---
> > Documentation/devicetree/usage-model.rst | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/devicetree/usage-model.rst b/Documentation/devicetree/usage-model.rst
> > index 326d7af10c5b..e1b42dc63f01 100644
> > --- a/Documentation/devicetree/usage-model.rst
> > +++ b/Documentation/devicetree/usage-model.rst
> > @@ -12,7 +12,7 @@ This article describes how Linux uses the device tree. An overview of
> > the device tree data format can be found on the device tree usage page
> > at devicetree.org\ [1]_.
>
> s/devicetree.org/elinux.org/
I wonder if we should make the devicetree.org link work again instead.
Primarily just to avoid the appearance of it being Linux specific.
The website is hosted on github[1] and I'd assume there's a way to do
redirects as a start.
Rob
[1] https://github.com/devicetree-org/devicetree-website
Em Mon, 2 Mar 2020 12:35:54 -0700
Jonathan Corbet <[email protected]> escreveu:
> On Mon, 2 Mar 2020 08:59:25 +0100
> Mauro Carvalho Chehab <[email protected]> wrote:
>
> > While most of the devicetree stuff has its own format (with is now being
> > converted to YAML format), some documents there are actually
> > describing the DT concepts and how to contribute to it.
> >
> > IMHO, those documents would fit perfectly as part of the documentation
> > body, as part of the firmare documents set.
> >
> > This patch series manually converts some DT documents that, on my
> > opinion, would belong to it.
>
> Did you consider putting this stuff into the firmware-guide while you were
> at it? It's not a perfect fit, I guess, but it doesn't seem too awkward
> either.
I placed it just below the firmware-guide at the main index file.
I have split thoughts about moving the files to there, though. From
one side, it may fit better from the PoV of organizing the documentation.
From other side, newcomers working with DT may expect looking at the
text files inside Documentation/devicetree/.
Maybe I could add an extra patch at the end of this series with the
move, adding a "RFC" on his title. This way, we can better discuss it,
and either merge the last one or not depending on the comments.
>
> It also seems like it would be good to CC the devicetree folks, or at
> least the devicetree mailing list?
Yeah, that would make sense. I'm using get-maintainers script to
prepare the c/c list, as it is simply too much work to find the
right maintainers by hand, for every single patch.
I just noticed today that there's just *one entry* at MAINTAINERS
file for Documentation/devicetree, and that points to you:
DOCUMENTATION
M: Jonathan Corbet <[email protected]>
L: [email protected]
S: Maintained
F: Documentation/
F: scripts/documentation-file-ref-check
F: scripts/kernel-doc
F: scripts/sphinx-pre-install
X: Documentation/ABI/
X: Documentation/firmware-guide/acpi/
X: Documentation/devicetree/
So, perhaps we should add something like this to MAINTAINERS:
diff --git a/MAINTAINERS b/MAINTAINERS
index fe3ab10354c2..64deb23dbb13 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12394,6 +12394,11 @@ L: [email protected]
S: Supported
F: drivers/infiniband/ulp/opa_vnic
+OPEN FIRMWARE
+L: [email protected]
+S: Maintained
+F: Documentation/devicetree
+
OPEN FIRMWARE AND DEVICE TREE OVERLAYS
M: Pantelis Antoniou <[email protected]>
M: Frank Rowand <[email protected]>
Em Mon, 2 Mar 2020 15:40:37 -0600
Rob Herring <[email protected]> escreveu:
> On Mon, Mar 2, 2020 at 3:11 PM Frank Rowand <[email protected]> wrote:
> >
> > On 3/2/20 1:59 AM, Mauro Carvalho Chehab wrote:
> > > The devicetree.org doesn't host the Device_Tree_Usage page
> > > anymore. So, fix the link to point to a new address.
> > >
> > > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> > > ---
> > > Documentation/devicetree/usage-model.rst | 2 +-
> > > 1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/Documentation/devicetree/usage-model.rst b/Documentation/devicetree/usage-model.rst
> > > index 326d7af10c5b..e1b42dc63f01 100644
> > > --- a/Documentation/devicetree/usage-model.rst
> > > +++ b/Documentation/devicetree/usage-model.rst
> > > @@ -12,7 +12,7 @@ This article describes how Linux uses the device tree. An overview of
> > > the device tree data format can be found on the device tree usage page
> > > at devicetree.org\ [1]_.
> >
> > s/devicetree.org/elinux.org/
>
> I wonder if we should make the devicetree.org link work again instead.
> Primarily just to avoid the appearance of it being Linux specific.
Makes sense to me. Another alternative would be to convert this file to
ReST and add to the Kernel docs (it should be easy to convert with pandoc).
Yet, as those references are part of the Linux Kernel documentation, it
doesn't sound wrong to me to have them pointing to a linux-specific site.
In any case, I'll update this patch, placing all such changes altogether.
This way, if you decide to re-add this at devicetree.org, we could simply
drop (or revert) it.
>
> The website is hosted on github[1] and I'd assume there's a way to do
> redirects as a start.
>
> Rob
>
> [1] https://github.com/devicetree-org/devicetree-website
On Tue, Mar 3, 2020 at 1:09 AM Mauro Carvalho Chehab
<[email protected]> wrote:
>
> Em Mon, 2 Mar 2020 12:35:54 -0700
> Jonathan Corbet <[email protected]> escreveu:
>
> > On Mon, 2 Mar 2020 08:59:25 +0100
> > Mauro Carvalho Chehab <[email protected]> wrote:
> >
> > > While most of the devicetree stuff has its own format (with is now being
> > > converted to YAML format), some documents there are actually
> > > describing the DT concepts and how to contribute to it.
> > >
> > > IMHO, those documents would fit perfectly as part of the documentation
> > > body, as part of the firmare documents set.
> > >
> > > This patch series manually converts some DT documents that, on my
> > > opinion, would belong to it.
> >
> > Did you consider putting this stuff into the firmware-guide while you were
> > at it? It's not a perfect fit, I guess, but it doesn't seem too awkward
> > either.
>
> I placed it just below the firmware-guide at the main index file.
>
> I have split thoughts about moving the files to there, though. From
> one side, it may fit better from the PoV of organizing the documentation.
>
> From other side, newcomers working with DT may expect looking at the
> text files inside Documentation/devicetree/.
>
> Maybe I could add an extra patch at the end of this series with the
> move, adding a "RFC" on his title. This way, we can better discuss it,
> and either merge the last one or not depending on the comments.
Keep in mind that we generate a standalone DT only tree[1] with the
documentation, dts files and headers. So things should be structured
such that all the DT documentation could be built by itself without
dependencies on the 'kernel documentation'. I'm not asking for that to
be done in this series, but just don't do anything to make that
harder. I don't *think* have, but just want to make sure that's clear.
> > It also seems like it would be good to CC the devicetree folks, or at
> > least the devicetree mailing list?
I was wondering what happened to the cover letter on v2...
> Yeah, that would make sense. I'm using get-maintainers script to
> prepare the c/c list, as it is simply too much work to find the
> right maintainers by hand, for every single patch.
>
> I just noticed today that there's just *one entry* at MAINTAINERS
> file for Documentation/devicetree, and that points to you:
>
> DOCUMENTATION
> M: Jonathan Corbet <[email protected]>
> L: [email protected]
> S: Maintained
> F: Documentation/
> F: scripts/documentation-file-ref-check
> F: scripts/kernel-doc
> F: scripts/sphinx-pre-install
> X: Documentation/ABI/
> X: Documentation/firmware-guide/acpi/
> X: Documentation/devicetree/
You mean doesn't point to Jon as 'X' is exclude. You missed this entry:
OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS
M: Rob Herring <[email protected]>
M: Mark Rutland <[email protected]>
L: [email protected]
T: git git://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git
Q: http://patchwork.ozlabs.org/project/devicetree-bindings/list/
S: Maintained
F: Documentation/devicetree/
F: arch/*/boot/dts/
F: include/dt-bindings/
Rob
[1] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/
Em Tue, 3 Mar 2020 10:20:25 -0600
Rob Herring <[email protected]> escreveu:
> On Tue, Mar 3, 2020 at 1:09 AM Mauro Carvalho Chehab
> <[email protected]> wrote:
> >
> > Em Mon, 2 Mar 2020 12:35:54 -0700
> > Jonathan Corbet <[email protected]> escreveu:
> >
> > > On Mon, 2 Mar 2020 08:59:25 +0100
> > > Mauro Carvalho Chehab <[email protected]> wrote:
> > >
> > > > While most of the devicetree stuff has its own format (with is now being
> > > > converted to YAML format), some documents there are actually
> > > > describing the DT concepts and how to contribute to it.
> > > >
> > > > IMHO, those documents would fit perfectly as part of the documentation
> > > > body, as part of the firmare documents set.
> > > >
> > > > This patch series manually converts some DT documents that, on my
> > > > opinion, would belong to it.
> > >
> > > Did you consider putting this stuff into the firmware-guide while you were
> > > at it? It's not a perfect fit, I guess, but it doesn't seem too awkward
> > > either.
> >
> > I placed it just below the firmware-guide at the main index file.
> >
> > I have split thoughts about moving the files to there, though. From
> > one side, it may fit better from the PoV of organizing the documentation.
> >
> > From other side, newcomers working with DT may expect looking at the
> > text files inside Documentation/devicetree/.
> >
> > Maybe I could add an extra patch at the end of this series with the
> > move, adding a "RFC" on his title. This way, we can better discuss it,
> > and either merge the last one or not depending on the comments.
>
> Keep in mind that we generate a standalone DT only tree[1] with the
> documentation, dts files and headers. So things should be structured
> such that all the DT documentation could be built by itself without
> dependencies on the 'kernel documentation'. I'm not asking for that to
> be done in this series, but just don't do anything to make that
> harder. I don't *think* have, but just want to make sure that's clear.
So, I guess it is better to keep the .rst files under Documentation/devicetree,
instead of moving them to Documentation/firmware-guide.
Well, if moved, I guess it would be easy to modify the scripts that produce
the documentation to also parse something a new directory inside
Documentation/firmware-guide.
>
> > > It also seems like it would be good to CC the devicetree folks, or at
> > > least the devicetree mailing list?
>
> I was wondering what happened to the cover letter on v2...
>
> > Yeah, that would make sense. I'm using get-maintainers script to
> > prepare the c/c list, as it is simply too much work to find the
> > right maintainers by hand, for every single patch.
> >
> > I just noticed today that there's just *one entry* at MAINTAINERS
> > file for Documentation/devicetree, and that points to you:
> >
> > DOCUMENTATION
> > M: Jonathan Corbet <[email protected]>
> > L: [email protected]
> > S: Maintained
> > F: Documentation/
> > F: scripts/documentation-file-ref-check
> > F: scripts/kernel-doc
> > F: scripts/sphinx-pre-install
> > X: Documentation/ABI/
> > X: Documentation/firmware-guide/acpi/
> > X: Documentation/devicetree/
>
> You mean doesn't point to Jon as 'X' is exclude. You missed this entry:
>
> OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS
> M: Rob Herring <[email protected]>
> M: Mark Rutland <[email protected]>
> L: [email protected]
> T: git git://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git
> Q: http://patchwork.ozlabs.org/project/devicetree-bindings/list/
> S: Maintained
> F: Documentation/devicetree/
> F: arch/*/boot/dts/
> F: include/dt-bindings/
Yeah, I remember I saw something like the above in the past. However,
I'm not seeing this entry at the MAINTAINERS file at next-20200303 anymore.
Did someone removed such entry?
>
>
> Rob
>
> [1] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/
Em Tue, 3 Mar 2020 18:01:09 +0100
Mauro Carvalho Chehab <[email protected]> escreveu:
> Em Tue, 3 Mar 2020 10:20:25 -0600
> Rob Herring <[email protected]> escreveu:
>
> > On Tue, Mar 3, 2020 at 1:09 AM Mauro Carvalho Chehab
> > <[email protected]> wrote:
> > >
> > > Em Mon, 2 Mar 2020 12:35:54 -0700
> > > Jonathan Corbet <[email protected]> escreveu:
> > >
> > > > On Mon, 2 Mar 2020 08:59:25 +0100
> > > > Mauro Carvalho Chehab <[email protected]> wrote:
> > > >
> > > > > While most of the devicetree stuff has its own format (with is now being
> > > > > converted to YAML format), some documents there are actually
> > > > > describing the DT concepts and how to contribute to it.
> > > > >
> > > > > IMHO, those documents would fit perfectly as part of the documentation
> > > > > body, as part of the firmare documents set.
> > > > >
> > > > > This patch series manually converts some DT documents that, on my
> > > > > opinion, would belong to it.
> > > >
> > > > Did you consider putting this stuff into the firmware-guide while you were
> > > > at it? It's not a perfect fit, I guess, but it doesn't seem too awkward
> > > > either.
> > >
> > > I placed it just below the firmware-guide at the main index file.
> > >
> > > I have split thoughts about moving the files to there, though. From
> > > one side, it may fit better from the PoV of organizing the documentation.
> > >
> > > From other side, newcomers working with DT may expect looking at the
> > > text files inside Documentation/devicetree/.
> > >
> > > Maybe I could add an extra patch at the end of this series with the
> > > move, adding a "RFC" on his title. This way, we can better discuss it,
> > > and either merge the last one or not depending on the comments.
> >
> > Keep in mind that we generate a standalone DT only tree[1] with the
> > documentation, dts files and headers. So things should be structured
> > such that all the DT documentation could be built by itself without
> > dependencies on the 'kernel documentation'. I'm not asking for that to
> > be done in this series, but just don't do anything to make that
> > harder. I don't *think* have, but just want to make sure that's clear.
>
> So, I guess it is better to keep the .rst files under Documentation/devicetree,
> instead of moving them to Documentation/firmware-guide.
>
> Well, if moved, I guess it would be easy to modify the scripts that produce
> the documentation to also parse something a new directory inside
> Documentation/firmware-guide.
>
> >
> > > > It also seems like it would be good to CC the devicetree folks, or at
> > > > least the devicetree mailing list?
> >
> > I was wondering what happened to the cover letter on v2...
> >
> > > Yeah, that would make sense. I'm using get-maintainers script to
> > > prepare the c/c list, as it is simply too much work to find the
> > > right maintainers by hand, for every single patch.
> > >
> > > I just noticed today that there's just *one entry* at MAINTAINERS
> > > file for Documentation/devicetree, and that points to you:
> > >
> > > DOCUMENTATION
> > > M: Jonathan Corbet <[email protected]>
> > > L: [email protected]
> > > S: Maintained
> > > F: Documentation/
> > > F: scripts/documentation-file-ref-check
> > > F: scripts/kernel-doc
> > > F: scripts/sphinx-pre-install
> > > X: Documentation/ABI/
> > > X: Documentation/firmware-guide/acpi/
> > > X: Documentation/devicetree/
> >
> > You mean doesn't point to Jon as 'X' is exclude. You missed this entry:
> >
> > OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS
> > M: Rob Herring <[email protected]>
> > M: Mark Rutland <[email protected]>
> > L: [email protected]
> > T: git git://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git
> > Q: http://patchwork.ozlabs.org/project/devicetree-bindings/list/
> > S: Maintained
> > F: Documentation/devicetree/
> > F: arch/*/boot/dts/
> > F: include/dt-bindings/
>
> Yeah, I remember I saw something like the above in the past. However,
> I'm not seeing this entry at the MAINTAINERS file at next-20200303 anymore.
>
> Did someone removed such entry?
Sorry, false alarm.
It is there at next.
I guess it is time for call it a day.
That doesn't explain why I didn't add DT ML to the c/c. I'll try to
verify what's going on tomorrow.
Regards,
Mauro