Re: [PATCH v2 00/12] Convert some DT documentation files to ReST

[Mauro Carvalho Chehab]

Em Mon, 2 Mar 2020 12:35:54 -0700
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> On Mon,  2 Mar 2020 08:59:25 +0100
> Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> 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 <corbet@xxxxxxx>
	L:      linux-doc@xxxxxxxxxxxxxxx
	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:	linux-rdma@xxxxxxxxxxxxxxx
 S:	Supported
 F:	drivers/infiniband/ulp/opa_vnic
 
+OPEN FIRMWARE
+L:	devicetree@xxxxxxxxxxxxxxx
+S:	Maintained
+F:	Documentation/devicetree
+
 OPEN FIRMWARE AND DEVICE TREE OVERLAYS
 M:	Pantelis Antoniou <pantelis.antoniou@xxxxxxxxxxxx>
 M:	Frank Rowand <frowand.list@xxxxxxxxx>