From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
"David S. Miller" <davem@davemloft.net>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
Joe Perches <joe@perches.com>,
Pantelis Antoniou <pantelis.antoniou@konsulko.com>,
Kevin Hilman <khilman@baylibre.com>,
Neil Armstrong <narmstrong@baylibre.com>,
Alex Shi <alex.shi@linux.alibaba.com>,
Jianxin Pan <jianxin.pan@amlogic.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Lee Jones <lee.jones@linaro.org>,
Christian Hewitt <christianshewitt@gmail.com>,
Federico Vaga <federico.vaga@vaga.pv.it>,
Nicolas Ferre <nicolas.ferre@microchip.com>,
Rob Herring <robh+dt@kernel.org>,
Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
Andy Whitcroft <apw@canonical.com>,
devicetree@vger.kernel.org, Harry Wei <harryxiyou@gmail.com>,
Jacob Huisman <jacobhuisman@kernelthusiast.com>,
Frank Rowand <frowand.list@gmail.com>
Subject: [PATCH v3 00/12] Convert some DT documentation files to ReST
Date: Wed, 15 Apr 2020 16:45:14 +0200 [thread overview]
Message-ID: <cover.1586961793.git.mchehab+huawei@kernel.org> (raw)
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
-
v3:
- rebased on the top of next-20200414
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.25.2
next reply other threads:[~2020-04-15 14:45 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-15 14:45 Mauro Carvalho Chehab [this message]
2020-04-15 14:45 ` [PATCH v3 01/12] docs: dt: add an index.rst file for devicetree Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 02/12] docs: dt: convert usage-model.txt to ReST Mauro Carvalho Chehab
2020-04-16 6:28 ` Lee Jones
2020-04-15 14:45 ` [PATCH v3 03/12] docs: dt: usage_model.rst: fix link for DT usage Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 04/12] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 05/12] docs: dt: convert changesets to ReST Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 06/12] docs: dt: convert dynamic-resolution-notes.txt " Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 07/12] docs: dt: convert of_unittest.txt " Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 08/12] docs: dt: convert overlay-notes.txt to ReST format Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 09/12] docs: dt: minor adjustments at writing-schema.rst Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 10/12] docs: dt: convert ABI.txt to ReST format Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 11/12] docs: dt: convert submitting-patches.txt " Mauro Carvalho Chehab
2020-04-15 14:45 ` [PATCH v3 12/12] docs: dt: convert writing-bindings.txt to ReST Mauro Carvalho Chehab
2020-05-05 3:38 ` [PATCH v3 00/12] Convert some DT documentation files " Rob Herring
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=cover.1586961793.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=alex.shi@linux.alibaba.com \
--cc=alexandre.belloni@bootlin.com \
--cc=apw@canonical.com \
--cc=christianshewitt@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=federico.vaga@vaga.pv.it \
--cc=frowand.list@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=harryxiyou@gmail.com \
--cc=jacobhuisman@kernelthusiast.com \
--cc=jianxin.pan@amlogic.com \
--cc=joe@perches.com \
--cc=khilman@baylibre.com \
--cc=konstantin@linuxfoundation.org \
--cc=lee.jones@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=martin.blumenstingl@googlemail.com \
--cc=narmstrong@baylibre.com \
--cc=nicolas.ferre@microchip.com \
--cc=pantelis.antoniou@konsulko.com \
--cc=robh+dt@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).