linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v3 00/12] Convert some DT documentation files to ReST
@ 2020-04-15 14:45 Mauro Carvalho Chehab
  2020-04-15 14:45 ` [PATCH v3 01/12] docs: dt: add an index.rst file for devicetree Mauro Carvalho Chehab
                   ` (12 more replies)
  0 siblings, 13 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-15 14:45 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
	Martin Blumenstingl, David S. Miller, Alexandre Belloni,
	Joe Perches, Pantelis Antoniou, Kevin Hilman, Neil Armstrong,
	Alex Shi, Jianxin Pan, Greg Kroah-Hartman, Lee Jones,
	Christian Hewitt, Federico Vaga, Nicolas Ferre, Rob Herring,
	Konstantin Ryabitsev, Andy Whitcroft, devicetree, Harry Wei,
	Jacob Huisman, Frank Rowand

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



^ permalink raw reply	[flat|nested] 15+ messages in thread
end of thread, other threads:[~2020-05-05  3:38 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-15 14:45 [PATCH v3 00/12] Convert some DT documentation files to ReST Mauro Carvalho Chehab
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

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).