[PATCH 00/16] doc: board: ti: Cleanup documentation

Nishanth Menon
2023-07-27T08:02:10Z

Hi,

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

Nishanth Menon (16):
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: 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/am62x_sk.rst | 240 +-
doc/board/ti/am65x_evm.rst | 300 +--
doc/board/ti/img/boot_diagram_am65.svg | 1835 +++++++++++++++
doc/board/ti/img/boot_diagram_j721e.svg | 2088 +++++++++++++++++
doc/board/ti/img/boot_diagram_k3_current.svg | 1987 ++++++++++++++++
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 | 487 ++++
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 | 98 +-
18 files changed, 10853 insertions(+), 819 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/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

--
2.40.0