fix(release-notes): use release-specific-build-information

StaticRocket · StaticRocket · commit 98b8ee2505e9 · 2025-11-07T15:36:30.000-06:00
Use the common release-specific-build-information tag instead of the
component specific tags. This data was always somewhat tabular but was
split over several sections with different formatting depending on the
platform. We are now looking to merge this under a single table like
what was done with AM62LX.

This initial merge made some links inaccessible for some platforms. This
attempts to go back and enforce a common tag name to make sure we are
always linking the user to at least a close section while the transition
occurs.

Signed-off-by: Randolph Sapp &lt;rs@ti.com&gt;
diff --git a/source/devices/AM335X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM335X/linux/Release_Specific_Release_Notes.rst
@@ -89,8 +89,6 @@ See :ref:`here <release-specific-supported-platforms-and-versions>` for a list o
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
diff --git a/source/devices/AM437X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM437X/linux/Release_Specific_Release_Notes.rst
@@ -87,8 +87,6 @@ See :ref:`here <release-specific-supported-platforms-and-versions>` for a list o
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
diff --git a/source/devices/AM57X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM57X/linux/Release_Specific_Release_Notes.rst
@@ -113,8 +113,6 @@ See `here <../../../linux/Release_Specific_Supported_Platforms_and_Versions.html
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
diff --git a/source/devices/AM62AX/linux/Release_Specific_Release_Notes.rst b/source/devices/AM62AX/linux/Release_Specific_Release_Notes.rst
@@ -92,8 +92,6 @@ What's new
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
@@ -105,8 +103,6 @@ U-Boot
 | uBoot Tag: 11.01.07
 |
 
-.. _tf-a-release-notes:
-
 TF-A
 ----
 | Head Commit: e0c4d3903b382bf34f552af53e6d955fae5283ab Merge changes from topic "xlnx_fix_gen_con_datatype" into integration
@@ -115,8 +111,6 @@ TF-A
 | Tag: (2.13 based)
 |
 
-.. _optee-release-notes:
-
 OP-TEE
 ------
 | Head Commit: 71785645fa6ce42db40dbf5a54e0eaedc4f61591 Update CHANGELOG for 4.6.0
@@ -125,8 +119,6 @@ OP-TEE
 | Tag: 4.6.0
 |
 
-.. _ti-linux-fw-release-notes:
-
 ti-linux-firmware
 -----------------
 | Head Commit: f59a711599249ecac75fea38b7a15ef9137d650d Merge branch 'main' of git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware into ti-linux-firmware-next
diff --git a/source/devices/AM62DX/linux/Release_Specific_Release_Notes.rst b/source/devices/AM62DX/linux/Release_Specific_Release_Notes.rst
@@ -66,8 +66,6 @@ What's included
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
@@ -79,8 +77,6 @@ U-Boot
 | uBoot Tag: 11.01.05
 |
 
-.. _tf-a-release-notes:
-
 TF-A
 ----
 | Head Commit: e0c4d3903b382bf34f552af53e6d955fae5283ab Merge changes from topic "xlnx_fix_gen_con_datatype" into integration
@@ -89,8 +85,6 @@ TF-A
 | Tag: (2.13 based)
 |
 
-.. _optee-release-notes:
-
 OP-TEE
 ------
 | Head Commit: 71785645fa6ce42db40dbf5a54e0eaedc4f61591 Update CHANGELOG for 4.6.0
@@ -99,8 +93,6 @@ OP-TEE
 | Tag: 4.6.0
 |
 
-.. _ti-linux-fw-release-notes:
-
 ti-linux-firmware
 -----------------
 | Head Commit: 33bec0e2ea9a25362c0c8243b2f1ed392dbc5b02 Merge branch 'main' of git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware into ti-linux-firmware-next
diff --git a/source/devices/AM62X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM62X/linux/Release_Specific_Release_Notes.rst
@@ -80,8 +80,6 @@ Build Information
 Arago (Yocto/OE)
 ----------------
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
@@ -93,8 +91,6 @@ U-Boot
 | uBoot Tag: 11.01.05
 |
 
-.. _tf-a-release-notes:
-
 TF-A
 ----
 | Head Commit: e0c4d3903b382bf34f552af53e6d955fae5283ab Merge changes from topic "xlnx_fix_gen_con_datatype" into integration
@@ -103,8 +99,6 @@ TF-A
 | Tag: (2.13 based)
 |
 
-.. _optee-release-notes:
-
 OP-TEE
 ------
 | Head Commit: 71785645fa6ce42db40dbf5a54e0eaedc4f61591 Update CHANGELOG for 4.6.0
@@ -113,8 +107,6 @@ OP-TEE
 | Tag: 4.6.0
 |
 
-.. _ti-linux-fw-release-notes:
-
 ti-linux-firmware
 -----------------
 | Head Commit: 33bec0e2ea9a25362c0c8243b2f1ed392dbc5b02 Merge branch 'main' of git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware into ti-linux-firmware-next
diff --git a/source/devices/AM64X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM64X/linux/Release_Specific_Release_Notes.rst
@@ -74,8 +74,6 @@ What's new
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
@@ -90,8 +88,6 @@ U-Boot
 | uBoot Tag: 11.01.05
 |
 
-.. _tf-a-release-notes:
-
 TF-A
 ----
 | Head Commit: e0c4d3903b382bf34f552af53e6d955fae5283ab Merge changes from topic "xlnx_fix_gen_con_datatype" into integration
@@ -100,8 +96,6 @@ TF-A
 | Tag: (2.13 based)
 |
 
-.. _optee-release-notes:
-
 OP-TEE
 ------
 | Head Commit: 71785645fa6ce42db40dbf5a54e0eaedc4f61591 Update CHANGELOG for 4.6.0
@@ -110,8 +104,6 @@ OP-TEE
 | Tag: 4.6.0
 |
 
-.. _ti-linux-fw-release-notes:
-
 ti-linux-firmware
 -----------------
 | Head Commit: 33bec0e2ea9a25362c0c8243b2f1ed392dbc5b02 Merge branch 'main' of git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware into ti-linux-firmware-next
diff --git a/source/devices/AM65X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM65X/linux/Release_Specific_Release_Notes.rst
@@ -80,8 +80,6 @@ See :ref:`here <release-specific-supported-platforms-and-versions>` for a list o
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 
@@ -92,8 +90,6 @@ U-Boot
 | uBoot Tag: 09.03.05
 |
 
-.. _tf-a-release-notes:
-
 TF-A
 ----
 
@@ -103,8 +99,6 @@ TF-A
 | Tag: 2.10+
 |
 
-.. _optee-release-notes:
-
 OP-TEE
 ------
 
@@ -114,8 +108,6 @@ OP-TEE
 | Tag: 4.1.0
 |
 
-.. _ti-linux-fw-release-notes:
-
 ti-linux-firmware
 -----------------
 
diff --git a/source/devices/J7_Family/linux/Release_Specific_Release_Notes.rst b/source/devices/J7_Family/linux/Release_Specific_Release_Notes.rst
@@ -90,8 +90,6 @@ Processor SDK 11.01 Release has following new features:
 Build Information
 =================
 
-.. _u-boot-release-notes:
-
 U-Boot
 ------
 | Head Commit: 743712b9ee4b33cc9739a3cbeb5a8f14ae2ccf35: TI: dts: arm64: ti: sync dtbs from ti-linux-6.12.y upto ce4785d01a0b
@@ -140,8 +138,6 @@ Kernel
 
       meta-edgeai Yocto layer contains additional patches for Kernel `here <https://git.ti.com/cgit/edgeai/meta-edgeai/tree/recipes-kernel/linux?h=11.01.00.03>`__.
 
-.. _tf-a-release-notes:
-
 TF-A
 ----
 | Head Commit: e0c4d3903b382bf34f552af53e6d955fae5283ab: Merge changes from topic "xlnx_fix_gen_con_datatype" into integration
@@ -152,8 +148,6 @@ TF-A
 | Branch: master
 |
 
-.. _optee-release-notes:
-
 OP-TEE
 ------
 | Head Commit: 71785645fa6ce42db40dbf5a54e0eaedc4f61591: Update CHANGELOG for 4.6.0
@@ -165,8 +159,6 @@ OP-TEE
 | Tag: 4.6.0
 |
 
-.. _ti-linux-fw-release-notes:
-
 ti-linux-firmware
 -----------------
 | Head Commit: e89a348f4618a26812fb353a04ed9532ef890a2f: Merge branch 'main' of git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware into ti-linux-firmware-next
diff --git a/source/linux/Foundational_Components/U-Boot/BG-Setup-K3.rst b/source/linux/Foundational_Components/U-Boot/BG-Setup-K3.rst
@@ -46,19 +46,5 @@ the source code is in the SDK at the path :file:`<path to tisdk>/board-support`.
 For your convenience the sources also includes
 git repositories including commit history.
 
-.. ifconfig:: CONFIG_part_variant in ('AM62LX')
-
-   Alternatively, BL-1 and U-Boot sources can directly be fetched from GIT. The GIT
-   repo URL, branch and commit id can be found in the release notes:
-
-   - ti-u-boot , OPTEE, TF-A and ti-linux-firmware version is at :ref:`release-specific-build-information`
-
-.. ifconfig:: CONFIG_part_variant not in ('AM62LX')
-
-   Alternatively, U-Boot sources can directly be fetched from GIT. The GIT
-   repo URL, branch and commit id can be found in the release notes:
-
-   - ti-u-boot version: :ref:`u-boot-release-notes`
-   - ti-linux-firmware version: :ref:`ti-linux-fw-release-notes`
-   - TF-A version: :ref:`tf-a-release-notes`
-   - OP-TEE version: :ref:`optee-release-notes`
+U-Boot sources can also be directly fetched from GIT. The GIT repository URL,
+branch and commit id is available in :ref:`release-specific-build-information`.
diff --git a/source/linux/Foundational_Components/U-Boot/BG-Setup-OMAP.rst b/source/linux/Foundational_Components/U-Boot/BG-Setup-OMAP.rst
@@ -44,6 +44,6 @@ git repositories including commit history.
 Alternatively, U-Boot sources can directly be fetched from GIT. The GIT
 repo URL, branch and commit id can be found in the release notes:
 
-- ti-u-boot version: :ref:`u-boot-release-notes`
+- ti-u-boot version: :ref:`release-specific-build-information`
 
 
diff --git a/source/linux/Foundational_Components_ATF.rst b/source/linux/Foundational_Components_ATF.rst
@@ -28,7 +28,7 @@ on to either the Linux kernel or U-Boot in the non-secure world.
 
 .. rubric:: Getting the ATF Source Code
 
-The pre-built TF-A binary is in TI Processor SDK: 
+The pre-built TF-A binary is in TI Processor SDK:
 <path-to-processor-sdk>/board-support/prebuilt-images/<optional-build-machine-name>/bl31.bin.
 Use this binary since it is tested with TI Processor SDK.
 
@@ -39,7 +39,7 @@ If it is not possible to use pre-build binary, use the following:
    $ git clone https://github.com/TexasInstruments/arm-trusted-firmware.git
    $ git checkout <hash>
 
-Where <hash> is the commit shown here: :ref:`tf-a-release-notes` :ref:`release-specific-build-information`.
+Where <hash> is the commit shown in :ref:`release-specific-build-information`.
 
 |
 
diff --git a/source/linux/Foundational_Components_OPTEE.rst b/source/linux/Foundational_Components_OPTEE.rst
@@ -27,7 +27,7 @@ If it is not possible to use pre-build binary, use the following:
     $ git clone https://github.com/OP-TEE/optee_os.git
     $ git checkout <hash>
 
-Where <hash> is the OPTEE commit shown here: :ref:`optee-release-notes`.
+Where <hash> is the OPTEE commit shown in :ref:`release-specific-build-information`.
 
 |
 
diff --git a/source/linux/How_to_Guides/Host/Boot_Sequence.rst b/source/linux/How_to_Guides/Host/Boot_Sequence.rst
@@ -7,7 +7,7 @@ Boot Sequence
     The J721E boot sequence is shown in the U-boot documentation file for J721E (doc/board/ti/j721e_evm.rst).
 
     Please refer back to the particular U-boot component branch and version information for this release:
-    :ref:`u-boot-release-notes`
+    :ref:`release-specific-build-information`
 
 .. ifconfig:: CONFIG_part_family in ('AM57X_family')
 
diff --git a/source/linux/Overview/GCC_ToolChain.rst b/source/linux/Overview/GCC_ToolChain.rst
@@ -312,7 +312,7 @@ follows.
 .. rubric:: Arm Toolchain setup
 
 Download the toolchain from `here <https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads>`__,
-and the version can be found in the :ref:`release notes <u-boot-release-notes>`.
+and the version can be found in the :ref:`release notes <release-specific-build-information>`.
 The following example shows how to download and set toolchain paths
 into a ``<COMPILER_PATH>`` directory in Linux Host using x86_64 architecture.
 The environment variables defined here will be referenced in the build
