Skip to content

Convert some DT documentation files to ReST

Mauro Carvalho Chehab linux-devicetree linux-doc lkml 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest12 patches 2 repliesIn review
  2. v212 patches 20 repliesSuperseded

Changes in v3 from the cover letter

- rebased on the top of next-20200414

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/12docs: dt: add an index.rst file for devicetreeDocumentation/devicetree/index.rst Documentation/index.rst+13 -00 replies
2/12docs: dt: convert usage-model.txt to ReSTDocumentation/devicetree/index.rst Documentation/devicetree/of_unittest.txt Documentation/devicetree/usage-model.rst +1 more+23 -171 reply
3/12docs: dt: usage_model.rst: fix link for DT usageDocumentation/devicetree/usage-model.rst+1 -10 replies
4/12docs: dt: convert booting-without-of.txt to ReST formatDocumentation/arm/booting.rst Documentation/devicetree/booting-without-of.rst Documentation/devicetree/index.rst +1 more+169 -1350 replies
5/12docs: dt: convert changesets to ReSTDocumentation/devicetree/changesets.rst Documentation/devicetree/index.rst+16 -90 replies
6/12docs: dt: convert dynamic-resolution-notes.txt to ReSTDocumentation/devicetree/dynamic-resolution-notes.rst Documentation/devicetree/index.rst Documentation/devicetree/overlay-notes.txt +1 more+7 -30 replies
7/12docs: dt: convert of_unittest.txt to ReSTDocumentation/devicetree/index.rst Documentation/devicetree/of_unittest.rst+98 -890 replies
8/12docs: dt: convert overlay-notes.txt to ReST formatDocumentation/devicetree/index.rst Documentation/devicetree/overlay-notes.rst MAINTAINERS+74 -700 replies
9/12docs: dt: minor adjustments at writing-schema.rstDocumentation/devicetree/writing-schema.rst+6 -30 replies
10/12docs: dt: convert ABI.txt to ReST formatDocumentation/arm/microchip.rst Documentation/devicetree/bindings/ABI.rst Documentation/devicetree/bindings/arm/amlogic.yaml +3 more+19 -40 replies
11/12docs: dt: convert submitting-patches.txt to ReST formatDocumentation/devicetree/bindings/index.rst Documentation/devicetree/bindings/submitting-patches.rst Documentation/devicetree/bindings/writing-bindings.txt +3 more+14 -70 replies
12/12docs: dt: convert writing-bindings.txt to ReSTDocumentation/devicetree/bindings/index.rst Documentation/devicetree/bindings/writing-bindings.rst+8 -00 replies

Reviews trailers per patch

1 of 12 patches has a Reviewed-by or Acked-by.

PatchLee Jones
1/12
2/12A-b
3/12
4/12
5/12
6/12
7/12
8/12
9/12
10/12
11/12
12/12

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v3 thread

Cover letter [PATCH v3 00/12] Convert some DT documentation files to ReST

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%)
Signature · 1 line
2.25.2