doc: board: ti: Cleanup documentation
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v2 Latest19 patches 0 repliesNew
- v116 patches 18 repliesSuperseded
Changes in v2 from the cover letter
* Document update to drop ARCH=arm and various fixes identified during review of V1
* Added a couple of patches (sorting board names and adding labels to reuse-memory maps)
* Few reviewed by pickups from Neha and Tom
* 3 new patches (bootflow cleanup, sorting boards in alpha order and labels to reuse memory map)
Patches in v2 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/19 | doc: board: ti: Optimize sources referencesdoc/ doc/ doc/ +2 more | +16 | 0 replies | |
| 2/19 | doc: board: ti: am62x/j7200: Update with common boot flow diagramdoc/ doc/ doc/ | +1927 | 0 replies | |
| 3/19 | doc: board: ti: am65x: Update with boot flow diagramdoc/ doc/ | +1780 | 0 replies | |
| 4/19 | doc: board: ti: j721e: Update with boot flow diagramdoc/ doc/ | +2013 | 0 replies | |
| 5/19 | doc: board: ti: k3: Reuse build instructionsdoc/ doc/ doc/ +2 more | +251 | 0 replies | |
| 6/19 | doc: board: ti: j7200: Convert the image format to svgdoc/ doc/ doc/ | +767 | 0 replies | |
| 7/19 | doc: board: ti: j721e: Convert the image format to svgdoc/ doc/ doc/ | +559 | 0 replies | |
| 8/19 | doc: board: ti: am65x: Convert the image format to svgdoc/ doc/ | +281 | 0 replies | |
| 9/19 | doc: board: ti: am62x: Convert the image format to svgdoc/ doc/ | +291 | 0 replies | |
| 10/19 | doc: board: ti: am62x_sk: Add labels to reuse memory mapdoc/ | +3 | 0 replies | |
| 11/19 | doc: board: ti: am62x_sk: Convert switch settings to list tablesdoc/ | +27 | 0 replies | |
| 12/19 | doc: board: ti: j7200_evm: Convert switch settings to list tablesdoc/ | +26 | 0 replies | |
| 13/19 | doc: board: ti: am65x_evm: Convert the UART boot responsibility to list tabledoc/ | +28 | 0 replies | |
| 14/19 | doc: board: ti: am65/j721e: Convert OSPI memory map to svgdoc/ doc/ doc/ | +723 | 0 replies | |
| 15/19 | doc: board: ti: am65x_evm: Convert the emmc layout to svgdoc/ doc/ | +749 | 0 replies | |
| 16/19 | doc: board: ti: j7200_evm: Convert the emmc layout to svgdoc/ doc/ doc/ | +1169 | 0 replies | |
| 17/19 | doc: board: ti: *: Add platform informationdoc/ doc/ doc/ +1 more | +17 | 0 replies | |
| 18/19 | doc: board: ti: k3: Sort the boards in alphabetical orderdoc/ | +2 | 0 replies | |
| 19/19 | board: ti: k3: Convert boot flow ascii flow to svgdoc/ doc/ doc/ +1 more | +1265 | 0 replies |
Reviews trailers per patch
4 of 19 patches have a Reviewed-by or Acked-by.
| Patch | Neha Malcom Francis | Tom Rini |
|---|---|---|
| 1/19 | R-b | R-b |
| 2/19 | R-b | |
| 3/19 | R-b | |
| 4/19 | R-b | |
| 5/19 | ||
| 6/19 | ||
| 7/19 | ||
| 8/19 | ||
| 9/19 | ||
| 10/19 | ||
| 11/19 | ||
| 12/19 | ||
| 13/19 | ||
| 14/19 | ||
| 15/19 | ||
| 16/19 | ||
| 17/19 | ||
| 18/19 | ||
| 19/19 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [PATCH V2 00/19] doc: board: ti: Cleanup documentation
As requested in the thread[1] and irc[2], this series cleansup board/ti documentation a bit.
Highlights:
* Reuse from k3.rst sources and build instructions at the same time satisfy needs of users to have a single page documentation on all the steps needed to build for a given platform.
* Replace ascii diagrams with actual svg diagrams (I have used a mix of drawio and inkscape to develop these, though inkscape should be sufficient to keep it updated). This also allows reuse based on common patterns.
* Convert all pending tables into list-tables
* Add information for folks who are looking for board information incontext of the documentation itself. (ever wondered what board is this documentation talking about?)
Changes from V1:
* Document update to drop ARCH=arm and various fixes identified during review of V1
* Added a couple of patches (sorting board names and adding labels to reuse-memory maps)
* Few reviewed by pickups from Neha and Tom
* 3 new patches (bootflow cleanup, sorting boards in alpha order and labels to reuse memory map)
V1: https://lore.kernel.org/all/[email protected]/
Nishanth Menon (19):
doc: board: ti: Optimize sources references
doc: board: ti: am62x/j7200: Update with common boot flow diagram
doc: board: ti: am65x: Update with boot flow diagram
doc: board: ti: j721e: Update with boot flow diagram
doc: board: ti: k3: Reuse build instructions
doc: board: ti: j7200: Convert the image format to svg
doc: board: ti: j721e: Convert the image format to svg
doc: board: ti: am65x: Convert the image format to svg
doc: board: ti: am62x: Convert the image format to svg
doc: board: ti: am62x_sk: Add labels to reuse memory map
doc: board: ti: am62x_sk: Convert switch settings to list tables
doc: board: ti: j7200_evm: Convert switch settings to list tables
doc: board: ti: am65x_evm: Convert the UART boot responsibility to
list table
doc: board: ti: am65/j721e: Convert OSPI memory map to svg
doc: board: ti: am65x_evm: Convert the emmc layout to svg
doc: board: ti: j7200_evm: Convert the emmc layout to svg
doc: board: ti: *: Add platform information
doc: board: ti: k3: Sort the boards in alphabetical order
board: ti: k3: Convert boot flow ascii flow to svg
doc/board/ti/am62x_sk.rst | 243 +- doc/board/ti/am65x_evm.rst | 298 +-- doc/board/ti/img/boot_diagram_am65.svg | 1779 +++++++++++++++ doc/board/ti/img/boot_diagram_j721e.svg | 2012 +++++++++++++++++ doc/board/ti/img/boot_diagram_k3_current.svg | 1925 ++++++++++++++++ doc/board/ti/img/boot_flow_01.svg | 220 ++ doc/board/ti/img/boot_flow_02.svg | 459 ++++ doc/board/ti/img/boot_flow_03.svg | 583 +++++ doc/board/ti/img/dm_tispl.bin.svg | 317 +++ doc/board/ti/img/emmc_am65x_evm_boot0.svg | 748 ++++++ doc/board/ti/img/emmc_j7200_evm_boot01.svg | 662 ++++++ doc/board/ti/img/emmc_j7200_evm_udafs.svg | 505 +++++ doc/board/ti/img/j7200_tiboot3.bin.svg | 447 ++++ doc/board/ti/img/multi_cert_tiboot3.bin.svg | 287 +++ .../ti/img/no_multi_cert_tiboot3.bin.svg | 238 ++ doc/board/ti/img/nodm_tispl.bin.svg | 277 +++ doc/board/ti/img/ospi_sysfw.svg | 721 ++++++ doc/board/ti/img/sysfw.itb.svg | 317 +++ doc/board/ti/j7200_evm.rst | 298 +-- doc/board/ti/j721e_evm.rst | 267 +-- doc/board/ti/k3.rst | 136 +- 21 files changed, 11895 insertions(+), 844 deletions(-) create mode 100644 doc/board/ti/img/boot_diagram_am65.svg create mode 100644 doc/board/ti/img/boot_diagram_j721e.svg create mode 100644 doc/board/ti/img/boot_diagram_k3_current.svg create mode 100644 doc/board/ti/img/boot_flow_01.svg create mode 100644 doc/board/ti/img/boot_flow_02.svg create mode 100644 doc/board/ti/img/boot_flow_03.svg create mode 100644 doc/board/ti/img/dm_tispl.bin.svg create mode 100644 doc/board/ti/img/emmc_am65x_evm_boot0.svg create mode 100644 doc/board/ti/img/emmc_j7200_evm_boot01.svg create mode 100644 doc/board/ti/img/emmc_j7200_evm_udafs.svg create mode 100644 doc/board/ti/img/j7200_tiboot3.bin.svg create mode 100644 doc/board/ti/img/multi_cert_tiboot3.bin.svg create mode 100644 doc/board/ti/img/no_multi_cert_tiboot3.bin.svg create mode 100644 doc/board/ti/img/nodm_tispl.bin.svg create mode 100644 doc/board/ti/img/ospi_sysfw.svg create mode 100644 doc/board/ti/img/sysfw.itb.svg
[1] https://lore.kernel.org/all/20230726164942.GW3630934@bill-the-cat/
[2] https://libera.irclog.whitequark.org/u-boot/2023-07-26
Regards,
Nishanth Menon
Signature · 1 line
2.40.0