From: Nishanth Menon <nm@ti.com>
To: <u-boot@lists.denx.de>, Tom Rini <trini@konsulko.com>
Cc: Wadim Egorov <w.egorov@phytec.de>,
Francesco Dolcini <francesco@dolcini.it>,
Sjoerd Simons <sjoerd@collabora.com>,
Neha Malcom Francis <n-francis@ti.com>,
Bryan Brattlof <bb@ti.com>, Vignesh Raghavendra <vigneshr@ti.com>,
Marcel Ziswiler <marcel.ziswiler@toradex.com>,
Nikhil Jain <n-jain1@ti.com>, Nishanth Menon <nm@ti.com>
Subject: [PATCH 01/16] doc: board: ti: Optimize sources references
Date: Thu, 27 Jul 2023 03:00:12 -0500 [thread overview]
Message-ID: <20230727080027.2817701-2-nm@ti.com> (raw)
In-Reply-To: <20230727080027.2817701-1-nm@ti.com>
We have duplication of sources which makes it hard to sustain across the
board, but at the same time, we'd like to ensure readers get specific
information without having to cross refer to different documentation to
get piecemeal information that they need to put together.
Signed-off-by: Nishanth Menon <nm@ti.com>
---
doc/board/ti/am62x_sk.rst | 17 +++--------------
doc/board/ti/am65x_evm.rst | 17 +++--------------
doc/board/ti/j7200_evm.rst | 17 +++--------------
doc/board/ti/j721e_evm.rst | 17 +++--------------
doc/board/ti/k3.rst | 4 ++++
5 files changed, 16 insertions(+), 56 deletions(-)
diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
index 3a122b075641..ba017a2b489e 100644
--- a/doc/board/ti/am62x_sk.rst
+++ b/doc/board/ti/am62x_sk.rst
@@ -115,21 +115,10 @@ Below is the pictorial representation of boot flow:
Sources:
--------
-1. Trusted Firmware-A:
- Tree: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/
- Branch: master
-
-2. OP-TEE:
- Tree: https://github.com/OP-TEE/optee_os.git
- Branch: master
-
-3. U-Boot:
- Tree: https://source.denx.de/u-boot/u-boot
- Branch: master
-4. TI Linux Firmware:
- Tree: git://git.ti.com/processor-firmware/ti-linux-firmware.git
- Branch: ti-linux-firmware
+.. include:: k3.rst
+ :start-after: .. k3_rst_include_start_boot_sources
+ :end-before: .. k3_rst_include_end_boot_sources
Build procedure:
----------------
diff --git a/doc/board/ti/am65x_evm.rst b/doc/board/ti/am65x_evm.rst
index 300cd3e9b960..466f720116b2 100644
--- a/doc/board/ti/am65x_evm.rst
+++ b/doc/board/ti/am65x_evm.rst
@@ -117,21 +117,10 @@ instead use Falcon boot flow to reduce boot time.
Sources:
--------
-1. Trusted Firmware-A:
- Tree: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/
- Branch: master
-
-2. OP-TEE:
- Tree: https://github.com/OP-TEE/optee_os.git
- Branch: master
-
-3. U-Boot:
- Tree: https://source.denx.de/u-boot/u-boot
- Branch: master
-4. TI Linux Firmware:
- Tree: git://git.ti.com/processor-firmware/ti-linux-firmware.git
- Branch: ti-linux-firmware
+.. include:: k3.rst
+ :start-after: .. k3_rst_include_start_boot_sources
+ :end-before: .. k3_rst_include_end_boot_sources
Build procedure:
----------------
diff --git a/doc/board/ti/j7200_evm.rst b/doc/board/ti/j7200_evm.rst
index 5e3d75059ca5..f81e3f43b7d7 100644
--- a/doc/board/ti/j7200_evm.rst
+++ b/doc/board/ti/j7200_evm.rst
@@ -120,21 +120,10 @@ Below is the pictorial representation of boot flow:
Sources:
--------
-1. Trusted Firmware-A:
- Tree: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/
- Branch: master
-
-2. OP-TEE:
- Tree: https://github.com/OP-TEE/optee_os.git
- Branch: master
-
-3. U-Boot:
- Tree: https://source.denx.de/u-boot/u-boot
- Branch: master
-4. TI Linux Firmware:
- Tree: git://git.ti.com/processor-firmware/ti-linux-firmware.git
- Branch: ti-linux-firmware
+.. include:: k3.rst
+ :start-after: .. k3_rst_include_start_boot_sources
+ :end-before: .. k3_rst_include_end_boot_sources
Build procedure:
----------------
diff --git a/doc/board/ti/j721e_evm.rst b/doc/board/ti/j721e_evm.rst
index 46244197f346..1cc32a242dde 100644
--- a/doc/board/ti/j721e_evm.rst
+++ b/doc/board/ti/j721e_evm.rst
@@ -130,21 +130,10 @@ support. Below is the pictorial representation of boot flow:
Sources:
--------
-1. Trusted Firmware-A:
- Tree: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/
- Branch: master
-
-2. OP-TEE:
- Tree: https://github.com/OP-TEE/optee_os.git
- Branch: master
-
-3. U-Boot:
- Tree: https://source.denx.de/u-boot/u-boot
- Branch: master
-4. TI Linux Firmware:
- Tree: git://git.ti.com/processor-firmware/ti-linux-firmware.git
- Branch: ti-linux-firmware
+.. include:: k3.rst
+ :start-after: .. k3_rst_include_start_boot_sources
+ :end-before: .. k3_rst_include_end_boot_sources
Build procedure:
----------------
diff --git a/doc/board/ti/k3.rst b/doc/board/ti/k3.rst
index 2db7bbdb42ec..2df57c9850ae 100644
--- a/doc/board/ti/k3.rst
+++ b/doc/board/ti/k3.rst
@@ -111,6 +111,8 @@ All scripts and code needed to build the `tiboot3.bin`, `tispl.bin` and
`u-boot.img` for all K3 SoCs can be located at the following places
online
+.. k3_rst_include_start_boot_sources
+
* **Das U-Boot**
| **source:** https://source.denx.de/u-boot/u-boot.git
@@ -131,6 +133,8 @@ online
| **source:** https://git.ti.com/git/processor-firmware/ti-linux-firmware.git
| **branch:** ti-linux-firmware
+.. k3_rst_include_end_boot_sources
+
Build Procedure
---------------
--
2.40.0
next prev parent reply other threads:[~2023-07-27 8:02 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-27 8:00 [PATCH 00/16] doc: board: ti: Cleanup documentation Nishanth Menon
2023-07-27 8:00 ` Nishanth Menon [this message]
2023-07-27 9:38 ` [PATCH 01/16] doc: board: ti: Optimize sources references Neha Malcom Francis
2023-07-27 14:07 ` Tom Rini
2023-07-27 8:00 ` [PATCH 02/16] doc: board: ti: am62x/j7200: Update with common boot flow diagram Nishanth Menon
2023-07-27 9:40 ` Neha Malcom Francis
2023-07-27 10:02 ` Neha Malcom Francis
2023-07-27 10:04 ` Neha Malcom Francis
2023-07-27 13:12 ` Nishanth Menon
2023-07-28 7:31 ` Heinrich Schuchardt
2023-07-28 12:40 ` Nishanth Menon
2023-07-27 14:08 ` Tom Rini
2023-07-27 8:00 ` [PATCH 03/16] doc: board: ti: am65x: Update with " Nishanth Menon
2023-07-27 9:41 ` Neha Malcom Francis
2023-07-27 8:00 ` [PATCH 04/16] doc: board: ti: j721e: " Nishanth Menon
2023-07-27 9:41 ` Neha Malcom Francis
2023-07-27 8:00 ` [PATCH 05/16] doc: board: ti: k3: Reuse build instructions Nishanth Menon
2023-07-27 9:47 ` Neha Malcom Francis
2023-07-27 14:08 ` Tom Rini
2023-07-27 8:00 ` [PATCH 06/16] doc: board: ti: j7200: Convert the image format to svg Nishanth Menon
2023-07-27 9:52 ` Neha Malcom Francis
2023-07-27 13:12 ` Nishanth Menon
2023-07-27 11:25 ` Neha Malcom Francis
2023-07-27 8:00 ` [PATCH 07/16] doc: board: ti: j721e: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 08/16] doc: board: ti: am65x: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 09/16] doc: board: ti: am62x: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 10/16] doc: board: ti: am62x_sk: Convert switch settings to list tables Nishanth Menon
2023-07-27 8:00 ` [PATCH 11/16] doc: board: ti: j7200_evm: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 12/16] doc: board: ti: am65x_evm: Convert the UART boot responsibility to list table Nishanth Menon
2023-07-27 8:00 ` [PATCH 13/16] doc: board: ti: am65/j721e: Convert OSPI memory map to svg Nishanth Menon
2023-07-27 8:00 ` [PATCH 14/16] doc: board: ti: am65x_evm: Convert the emmc layout " Nishanth Menon
2023-07-27 8:00 ` [PATCH 15/16] doc: board: ti: j7200_evm: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 16/16] doc: board: ti: *: Add platform information Nishanth Menon
2023-07-27 13:43 ` [PATCH 00/16] doc: board: ti: Cleanup documentation Nishanth Menon
2023-07-27 14:08 ` Tom Rini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230727080027.2817701-2-nm@ti.com \
--to=nm@ti.com \
--cc=bb@ti.com \
--cc=francesco@dolcini.it \
--cc=marcel.ziswiler@toradex.com \
--cc=n-francis@ti.com \
--cc=n-jain1@ti.com \
--cc=sjoerd@collabora.com \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=vigneshr@ti.com \
--cc=w.egorov@phytec.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox