fix(references): Update cross referencing to docs for Program EVM User Guide, UG-SATA and UFS and Release Specific Migration Guide

jeevantelukula · StaticRocket · commit 3fd6c258b935 · 2024-11-21T15:05:47.000-06:00
Update the cross referencing to other docs(UG-SATA, UFS) replacing ref tag with doc tag which directly point to the document
Update the Release Specific Migration Guide references
Update referencing the links through html to using ref tags and change http protocol to https

Signed-off-by: Telukula Jeevan Kumar Sahu &lt;j-sahu@ti.com&gt;
diff --git a/source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst
@@ -495,7 +495,7 @@ Connect to EVMK2H using CCS
 
 .. note::
    For newer versions of CCS, a XDS200 firmware update is recommended which user can perform using instruction on the article
-   `Updating XDS200 Firmware <http://dev.ti.com/tirex/explore/node?node=AADzJ8Y-La4f7Bi5Ga0TcA__FUz-xrs__LATEST>`__
+   `Updating XDS200 Firmware <https://dev.ti.com/tirex/explore/node?node=AADzJ8Y-La4f7Bi5Ga0TcA__FUz-xrs__LATEST>`__
 
 **Step 2:** Create CCS Target configuration
 
diff --git a/source/common/PRU-ICSS/PRU-Hands-on-Labs.rst b/source/common/PRU-ICSS/PRU-Hands-on-Labs.rst
@@ -60,7 +60,7 @@ Software
    However, the notation ***<PRU_SW_PATH>*** will be used throughout
    the labs to reference this assumed installation location. If you use
    a different location please modify the steps below.
--  `CCSv6 <ti.com/tool/download/CCSTUDIO>`__
+-  `CCSv6 <https://www.ti.com/tool/download/CCSTUDIO>`__
 -  `PRU Code Generation
    Tools <http://software-dl.ti.com/codegen/non-esd/downloads/download.htm#PRU>`__
    (also available through the CCS App Center)
@@ -971,7 +971,7 @@ to your set up.
    a. Use the script included with the SDK to create a bootable SD card.
 
       You can find instructions on this process at the
-      `Linux SD Card Creation Guide <../../linux/Overview/Processor_SDK_Linux_create_SD_card.html>`__.
+      :ref:`Linux SD Card Creation Guide <processor-sdk-linux-create-sd-card>`.
 
    b. Once the card is created, mount it on your Linux host to copy the
       files to it.
diff --git a/source/devices/AM335X/linux/Release_Specific_Migration_Guide.rst b/source/devices/AM335X/linux/Release_Specific_Migration_Guide.rst
@@ -131,7 +131,7 @@ Processor SDK 05.02
 Processor SDK 05.01
 ----------------------
 
-- Introduced AM65x as a new platform. Please refer to release notes for more details
+- Introduced AM65x as a new platform.
 
 .. rubric:: PRUETH Driver
 
@@ -432,7 +432,6 @@ Processor SDK 03.03
 
 -  HDMI-connected monitor no longer takes precedence over built-in LCD
    as a default graphics display for e.g. Matrix
--  See the Release Notes for full list of modifications.
 
 |
 
@@ -441,8 +440,8 @@ Processor SDK 03.02
 
 -  The QT QPA eglfs\_kms, which supports multiple screens, has been
    enabled and used as the default eglfs platform plugin. For more
-   information, see `QT and Graphics
-   Migration <../../../linux/Foundational_Components_Graphics.html>`__
+   information, see :ref:`QT and Graphics
+   Migration <from-processor-sdk-3-1-to-3-x-for-am3-4-5>`
 -  bootmonitor now goes thru mkimage and as a result the load address
    changed. Users should manually execute following commands in their
    u-boot environment to properly install the secure monitor on k2
@@ -496,7 +495,6 @@ Processor SDK 03.00
 -  In K2 U-Boot, multi slave support is currently missing. To use
    multiple interfaces, please disable CONFIG\_DM\_ET option in u-boot
    .config and build.
--  See the Release Notes for full list of modifications.
 
 |
 
@@ -510,9 +508,8 @@ Processor SDK 02.00.02
 -  OpenCV now uses OpenCL under the hood, to offload compute tasks to
    C66x cores. This is transparent to the application
 -  The SGX driver for AM335x has been enhanced to support DRM/WAYLAND
-   based Multi-Window Display. For more information, see `AM3 Graphics
-   Migration <../../../linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.html#from-processor-sdk-2-0-1-to-2-0-x-for-am3-4-5>`__
--  See the Release Notes for full list of modifications.
+   based Multi-Window Display. For more information, see :ref:`AM3 Graphics
+   Migration <from-processor-sdk-2-0-1-to-2-0-x-for-am3-4-5>`
 
 |
 
@@ -523,10 +520,9 @@ Processor SDK 02.00.01
 -  This release also supports RT Linux is supported on AM4 and AM5
    device
 -  The SGX driver for AM4 has been enhanced to support DRM/WAYLAND based
-   Multi-Window Display. For more information, see `AM4 Graphics
-   Migration <../../../linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.html#from-processor-sdk-2-0-0-to-2-0-x-for-am4>`__
+   Multi-Window Display. For more information, see :ref:`AM4 Graphics
+   Migration <from-processor-sdk-2-0-0-to-2-0-x-for-am4>`
 -  There is no migration impact to customers using AM3, and AM5.
--  See the Release Notes for full list of modifications.
 
 |
 
@@ -540,9 +536,7 @@ Processor SDK 02.00.00
 -  For AM3, AM4, Graphics SDK is now obsolete and Graphics stack is
    integrated into Processor SDK, and supports null DRM based Full
    Window, with Front and Flip modes. For more information, see
-   `Graphics
-   Migration <../../../linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.html#from-processor-sdk-1-x-to-2-x-for-am3-am4>`__
+   :ref:`Graphics Migration <from-processor-sdk-1-x-to-2-x-for-am3-am4>`
 -  Ethernet performance degraded ~10% on am335x-evm due to move from
    preempt\_voluntary
--  See the Release Notes for full list of modifications.
 
diff --git a/source/devices/AM437X/linux/Release_Specific_Migration_Guide.rst b/source/devices/AM437X/linux/Release_Specific_Migration_Guide.rst
@@ -132,7 +132,7 @@ Processor SDK 05.02
 Processor SDK 05.01
 ----------------------
 
-- Introduced AM65x as a new platform. Please refer to release notes for more details
+- Introduced AM65x as a new platform.
 
 .. rubric:: PRUETH Driver
 
@@ -433,9 +433,6 @@ Processor SDK 03.03
 
 -  HDMI-connected monitor no longer takes precedence over built-in LCD
    as a default graphics display for e.g. Matrix
--  See the `Release
-   Notes <http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_Release_Notes>`__
-   for full list of modifications.
 
 |
 
@@ -444,8 +441,8 @@ Processor SDK 03.02
 
 -  The QT QPA eglfs\_kms, which supports multiple screens, has been
    enabled and used as the default eglfs platform plugin. For more
-   information, see `QT and Graphics
-   Migration <http://processors.wiki.ti.com/index.php/Processor_Linux_SDK_Graphics_and_Display#Migration_Guide_from_Processor_SDK_3.1_to_3.x_for_AM3.2F4.2F5>`__
+   information, see :ref:`QT and Graphics
+   Migration <from-processor-sdk-3-1-to-3-x-for-am3-4-5>`
 -  bootmonitor now goes thru mkimage and as a result the load address
    changed. Users should manually execute following commands in their
    u-boot environment to properly install the secure monitor on k2
@@ -499,7 +496,6 @@ Processor SDK 03.00
 -  In K2 U-Boot, multi slave support is currently missing. To use
    multiple interfaces, please disable CONFIG\_DM\_ET option in u-boot
    .config and build.
--  See the Release Notes for full list of modifications.
 
 |
 
@@ -513,11 +509,8 @@ Processor SDK 02.00.02
 -  OpenCV now uses OpenCL under the hood, to offload compute tasks to
    C66x cores. This is transparent to the application
 -  The SGX driver for AM335x has been enhanced to support DRM/WAYLAND
-   based Multi-Window Display. For more information, see `AM3 Graphics
-   Migration <http://processors.wiki.ti.com/index.php/Processor_Linux_SDK_Graphics_and_Display#Migration_Guide_from_Processor_SDK_2.0.0_to_2.0.x_for_AM4>`__
--  See the `Release
-   Notes <http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_Release_Notes#Release_02.00.02>`__
-   for full list of modifications.
+   based Multi-Window Display. For more information, see :ref:`AM3 Graphics
+   Migration <from-processor-sdk-2-0-1-to-2-0-x-for-am3-4-5>`
 
 |
 
@@ -528,12 +521,9 @@ Processor SDK 02.00.01
 -  This release also supports RT Linux is supported on AM4 and AM5
    device
 -  The SGX driver for AM4 has been enhanced to support DRM/WAYLAND based
-   Multi-Window Display. For more information, see `AM4 Graphics
-   Migration <http://processors.wiki.ti.com/index.php/Processor_Linux_SDK_Graphics_and_Display#Migration_Guide_from_Processor_SDK_2.0.0_to_2.0.x_for_AM4>`__
+   Multi-Window Display. For more information, see :ref:`AM4 Graphics
+   Migration <from-processor-sdk-2-0-0-to-2-0-x-for-am4>`
 -  There is no migration impact to customers using AM3, and AM5.
--  See the `Release
-   Notes <http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_Release_Notes#Release_02.00.01>`__
-   for full list of modifications.
 
 |
 
@@ -547,11 +537,6 @@ Processor SDK 02.00.00
 -  For AM3, AM4, Graphics SDK is now obsolete and Graphics stack is
    integrated into Processor SDK, and supports null DRM based Full
    Window, with Front and Flip modes. For more information, see
-   `Graphics
-   Migration <http://processors.wiki.ti.com/index.php/Processor_Linux_SDK_Graphics_and_Display#Migration_Guide_from_Processor_SDK_1.x_to_2.x_for_AM3.2C_AM4>`__
--  Ethernet performance degraded ~10% on am335x-evm due to move from
+   :ref:`Graphics Migration <from-processor-sdk-1-x-to-2-x-for-am3-am4>`
    preempt\_voluntary
--  See the `Release
-   Notes <http://processors.wiki.ti.com/index.php?title=Processor_SDK_Linux_Release_Notes%26oldid%3D207973&action=edit&redlink=1>`__
-   for full list of modifications.
 
diff --git a/source/linux/Examples_and_Demos/_Hands_on_with_QT.rst b/source/linux/Examples_and_Demos/_Hands_on_with_QT.rst
@@ -93,13 +93,12 @@ be adapted accordingly.
 -  SD card with Sitara Linux SDK installed.
 
    -  For help creating a 2 partition SD card with the SDK content see
-      the `create\_sdcard.sh
-      script <Overview/Processor_SDK_Linux_create_SD_card.html>`__ page
+      the :ref:`create\_sdcard.sh script <processor-sdk-linux-sd-card-with-default-images>` page
 
 -  QT Creator 5.7.0 installed on your Linux host.
 
    -  You can download Qt Creator from open source distribution version
-      of Qt at http://download.qt.io/official_releases/qt/
+      of Qt at https://download.qt.io/official_releases/qt/
    -  QT will download as a .run file. Make the file executable by
       running the **chmod + <qtfile>** command and **./<qtfile>**. These
       steps should launch the QT installer.
@@ -1460,7 +1459,7 @@ corresponding QT library will need to be installed to the
 <ti-processor-sdk-linux-xxx>/linux-devkit/sysroots/armv7ahf-neon-linux-gnueabi
 location. The \*.ipk package can be found from the
 :ref:`yocto build of PSDK <building-the-sdk-with-yocto>`
-under build/arago-tmp-external-arm-toolchain/work/armv7ahf-neon-linux-gnueabi.
+under :file:`build/arago-tmp-external-arm-toolchain/work/armv7ahf-neon-linux-gnueabi`.
 Linux "find" command can be used to refine the search for \*.ipk file.
 For example, following steps to debug qtbase application
 
diff --git a/source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst b/source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst
@@ -6,6 +6,8 @@
 Migration from prior releases
 #############################
 
+.. _from-processor-sdk-1-x-to-2-x-for-am3-am4:
+
 ******************************************
 From Processor SDK 1.x to 2.x for AM3, AM4
 ******************************************
@@ -61,6 +63,8 @@ the SDK file system:
 
    - :file:`/usr/bin/sgx_render_test`
 
+.. _from-processor-sdk-2-0-0-to-2-0-x-for-am4:
+
 *****************************************
 From Processor SDK 2.0.0 to 2.0.x for AM4
 *****************************************
@@ -91,6 +95,8 @@ The window system will be dynamically loaded by DDK based on the application use
 case, so that the PVR configuration parameter WindowSystem at the PVR
 configuration file :file:`/etc/powervr.ini` is no longer used.
 
+.. _from-processor-sdk-2-0-1-to-2-0-x-for-am3-4-5:
+
 **********************************************
 From Processor SDK 2.0.1 to 2.0.x for AM3/4/5
 **********************************************
@@ -119,6 +125,8 @@ application use case, so that the PVR configuration parameter
 WindowSystem at the PVR configuration file /etc/powervr.ini is no longer
 required.
 
+.. _from-processor-sdk-3-1-to-3-x-for-am3-4-5:
+
 *****************************************
 From Processor SDK 3.1 to 3.x for AM3/4/5
 *****************************************
diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/UFS.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/UFS.rst
@@ -1,5 +1,3 @@
-.. _ufs:
-
 UFS
 ---------------------------------
 
diff --git a/source/linux/Foundational_Components/Kernel/_Users_Guide.rst b/source/linux/Foundational_Components/Kernel/_Users_Guide.rst
@@ -34,6 +34,7 @@ Alternatively, Kernel sources can directly be fetched from GIT.
     You can find the details about the git repository, branch and commit id in
     the :ref:`release-specific-build-information-kernel` section of the release notes.
 
+.. _preparing-to-build:
 
 Preparing to Build
 ------------------
diff --git a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst
@@ -232,7 +232,7 @@ Here are the steps needed to test out the new Ethernet interfaces:
    -  follow the script directions to format your SD card and then
       install the pre-built binaries from the SDK
    -  for more information on creating an SD card:
-      `Processor\_SDK\_Linux\_create\_SD\_card\_script <Overview/Processor_SDK_Linux_create_SD_card.html>`__
+      :ref:`Processor\_SDK\_Linux\_create\_SD\_card\_script <processor-sdk-linux-sd-card-with-default-images>`
 
 -  Boot from the newly created SD card
 
diff --git a/source/linux/Foundational_Components/U-Boot/UG-SATA.rst b/source/linux/Foundational_Components/U-Boot/UG-SATA.rst
@@ -1,5 +1,3 @@
-.. _ug-sata:
-
 SATA
 ------------------------------------
 
diff --git a/source/linux/Foundational_Components/U-Boot/UG-UFS.rst b/source/linux/Foundational_Components/U-Boot/UG-UFS.rst
@@ -27,10 +27,10 @@ Then we can go ahead with 'scsi scan' to see the attached devices:
 |
 
 All the remaining scsi commands detailed in the
-:ref:`previous section <ug-sata>` are
+:doc:`previous section <UG-SATA>` are
 also applicable.
 
 For more information about UFS see
-:ref:`Kernel UFS Guide <ufs>`.
+:doc:`Kernel UFS Guide <../Kernel/Kernel_Drivers/UFS>`.
 
 
diff --git a/source/linux/Foundational_Components/_OpenCV.rst b/source/linux/Foundational_Components/_OpenCV.rst
@@ -538,7 +538,7 @@ to AM57xx): **export OPENCV\_OPENCL\_DEVICE='TI AM57:ACCELERATOR:TI
 Multicore C66 DSP'**
 
 -  For additional information, please refer to:
-   `OpenCL User Guide <http://downloads.ti.com/mctools/esd/docs/opencl/index.html>`__
+   `OpenCL User Guide <https://downloads.ti.com/mctools/esd/docs/opencl/index.html>`__
 
 --------------------------------
 OpenCV OpenCL development setup
diff --git a/source/linux/How_to_Guides/Board_Port/Linux.rst b/source/linux/How_to_Guides/Board_Port/Linux.rst
@@ -106,9 +106,8 @@ file.
 
 * Test the minimal Hello World Linux Board Port
 
-   #. Create a bootable SD card by following the steps outlined in the `Linux SD
-      Card Creation Guide
-      <../../Overview/Processor_SDK_Linux_create_SD_card.html>`__. It is
+   #. Create a bootable SD card by following the steps outlined in the :ref:`Linux SD
+      Card Creation Guide <processor-sdk-linux-create-sd-card>`. It is
       recommended to follow the steps to create a "SD Card Using Default Images."
 
    #. Make a copy of the **am335x-boneblack.dtb** file in the SD card root file
diff --git a/source/linux/How_to_Guides/Target/How_to_Boot_Beagle_Bone_Black_with_Processor_SDK_Linux.rst b/source/linux/How_to_Guides/Target/How_to_Boot_Beagle_Bone_Black_with_Processor_SDK_Linux.rst
@@ -9,7 +9,7 @@ How to Boot Beagle Bone Black with Processor SDK Linux
 By default, BeagleBone Black EVM boots with the Debian image on eMMC.
 This page describes two ways to boot a BeagleBone Black EVM with
 Processor SDK Linux. First, create an SD card with processor SDK Linux
-(`Create SD Card <../../Overview/Processor_SDK_Linux_create_SD_card.html>`__).
+(:ref:`Create SD Card <processor-sdk-linux-create-sd-card>`).
 Then, choose either of the two procedures below to boot with Processor
 SDK Linux.
 
diff --git a/source/linux/How_to_Guides/Target/How_to_Program_Beaglebone_Black_eMMC_via_SD_Card.rst b/source/linux/How_to_Guides/Target/How_to_Program_Beaglebone_Black_eMMC_via_SD_Card.rst
@@ -28,8 +28,8 @@ What is Needed
 
 Preparing the SD Card
 ---------------------
-* Follow the steps outlined in the `Linux SD Card Creation Guide
-  <../../Overview/Processor_SDK_Linux_create_SD_card.html>`__.
+* Follow the steps outlined in the :ref:`Linux SD Card Creation Guide
+  <processor-sdk-linux-sd-card-with-default-images>`.
 * For this guide, it is recommended to follow the steps to create an "SD Card
   Using Default Images."
 * Once the SD Card has been created with default
diff --git a/source/linux/Overview/Processor_SDK_Linux_Getting_Started_Guide.rst b/source/linux/Overview/Processor_SDK_Linux_Getting_Started_Guide.rst
@@ -161,7 +161,7 @@ to get the imagination active and engaged.
     Black <http://beagleboard.org/Products/BeagleBone%20Black>`__, you might
     not have a SD card with the SDK on it. Or, maybe, the SDK on your SD
     card is simply a few revisions old and you want the latest and greatest.
-    If that is the case, check out the `Create SD Card <Processor_SDK_Linux_create_SD_card.html>`__
+    If that is the case, check out the :ref:`Create SD Card <processor-sdk-linux-create-sd-card>`
     page. Just remember, you won’t be able to build or change anything,
     simply evaluate the SDK Embedded Linux System with Matrix as delivered.
     But, even this is enough to get the imagination going and all some folks
@@ -253,8 +253,8 @@ which you can start development.
 
    .. ifconfig:: CONFIG_sdk in ('SITARA')
 
-       Use the `Create SD Card <Processor_SDK_Linux_create_SD_card.html>`__,
-       or **One-time Program EVM for K2H/K2K, K2E, and K2L** - following directions for :ref:`Program EVM User Guide <program-evm-user-guide>`
+       Use the :doc:`Create SD Card <Processor_SDK_Linux_create_SD_card>`,
+       or **One-time Program EVM for K2H/K2K, K2E, and K2L** - following directions for :doc:`Program EVM User Guide <Program_EVM>`
 
    .. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')
 
diff --git a/source/linux/Overview/Program_EVM.rst b/source/linux/Overview/Program_EVM.rst
@@ -1,7 +1,5 @@
 .. http://processors.wiki.ti.com/index.php/Program_EVM_UG
 
-.. _program-evm-user-guide:
-
 Program EVM User Guide
 ======================
 
diff --git a/source/linux/Release_Specific/_CoreSDK_Linux_Migration_Guide.rst b/source/linux/Release_Specific/_CoreSDK_Linux_Migration_Guide.rst
@@ -33,7 +33,6 @@ Processor CoreSDK Sitara 10.00
       instructions<Build-U-Boot-label>` for the updated steps.
 
     - For Linux builds, generic ``defconfig`` is used instead of custom
-      fragments. Please refer to `linux users guide
-      <../../../linux/Foundational_Components_Kernel_Users_Guide.html#preparing-to-build>`__
+      fragments. Please refer to :ref:`linux users guide <preparing-to-build>`
       for build instructions.
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-.. _ufs:`
`2`		`-`
`3`	`1`	`UFS`
`4`	`2`	`---------------------------------`
`5`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-.. _ug-sata:`
`2`		`-`
`3`	`1`	`SATA`
`4`	`2`	`------------------------------------`
`5`	`3`