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

From
Frank Rowand <hidden>
Date
2020-03-02 21:10:54
Also in
lkml
Reply to
Mauro Carvalho Chehab, 2020-03-02
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%)
  
Thread (33 messages) 33 messages, 7 authors, last reply 2020-03-05
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help