Skip to content

Commit

Permalink
fix: Switch from relative links to :ref: for cross-referencing
Browse files Browse the repository at this point in the history
Use :ref: for cross-referencing to arbitrary locations in the
entire document

Signed-off-by: Chirag Shilwant <[email protected]>
  • Loading branch information
cshilwant authored and StaticRocket committed Dec 16, 2024
1 parent 202d79c commit be5ca4f
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ Processor SDK AM62Px support GNU make based build system.

Refer the respective user guides to build Linux and other RTOS/NO-RTOS packages

- For Linux Kernel, u-boot & DTB `[Use Link] <../../../../linux/Foundational_Components.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/index.html>`__
- For Linux Kernel, u-boot & DTB - `[Use Link] <foundational-components-linux>`
- For RTOS/NO-RTOS source (MCU+ SDK) - `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/index.html>`__
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Processor SDK AM62x support GNU make based build system.

Refer the respective user guides to build Linux and other RTOS/NO-RTOS packages

- For Linux Kernel, u-boot & DTB `[Use Link] <../../../../linux/Foundational_Components.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/09_02_00_38/exports/docs/api_guide_am62x/index.html>`__
- For Linux Kernel, u-boot & DTB - :ref:`[Use Link] <foundational-components-linux>`
- For RTOS/NO-RTOS source (MCU+ SDK) - `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/09_02_00_38/exports/docs/api_guide_am62x/index.html>`__



Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ Processor SDK 10.00.07.04
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 Kernel User Guide <preparing-to-build>`
for build instructions.

.. include:: /linux/Release_Specific/_AM62_Enable_UHS_MMCSD.rst
Expand Down
2 changes: 2 additions & 0 deletions source/linux/Foundational_Components.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _foundational-components-linux:

############################
Foundational Components
############################
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,8 @@ I2C2 and CSI-RX Port 0:
status = "okay";
};
.. _enabling-camera-sensors:

***********************
Enabling camera sensors
***********************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ Build U-Boot
:name: target-images

Copy the below images to the boot partition of an SD card and boot.
Instructions to format the SD card can be found `here <../../Overview/Processor_SDK_Linux_create_SD_card.html>`__.
Instructions to format the SD card can be found :ref:`here <processor-sdk-linux-create-sd-card>`.

.. ifconfig:: CONFIG_part_variant in ('AM65X')

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ mention, a new Operating System (OS) for many), is getting an
environment set up where you can build and debug code on hardware. The
SDK attacks this problem with providing everything you need to do
development, and it is validated on standard TI hardware platforms
(EVMs) (see `here <../Release_Specific_Supported_Platforms_and_Versions.html>`__ for more details).
(EVMs) (see :ref:`here <release-specific-supported-platforms-and-versions>` for more details).
It wraps all of this up into one simple installer that helps get
everything you need in the right place to do development. For example,
you can start off with simply re-building the Linux Embedded System
Expand All @@ -59,7 +59,7 @@ What would you like to do with the SDK?
As described above, the SDK has a lot to it. Let’s break it down to two
pieces to simplify things a bit:

- The example `Embedded Linux System <../Overview_Software_Stack.html>`__.
- The example :ref:`Embedded Linux System <linux-software-stack>`.
Essentially, a working bootloader (U-Boot), Linux
kernel, and filesystem that can be put on an SD card and ran on a TI
EVMs.
Expand Down Expand Up @@ -126,7 +126,7 @@ something, check out the next section which shares how to play with the
embedded Linux system |__FEATURINGMATRIX__|, the first piece of the SDK
mentioned earlier. All you’ll need is access to a Linux
computer, a SD card, a SD card reader, some free, open-source software,
and a supported `Hardware Platform <../Release_Specific_Supported_Platforms_and_Versions.html>`__.
and a supported :ref:`Hardware Platform <release-specific-supported-platforms-and-versions>`.

.. ifconfig:: CONFIG_sdk in ('SITARA')

Expand All @@ -143,7 +143,7 @@ presentations gets old fast. So, if you want to see an example of what
you can build with the SDK and actually hold it in your hands and play
with it (or show it to someone else that needs help understanding what
you want to do with it), with minimal effort, you can simply run the
SDK Embedded Linux System |__FEATURINGMATRIX__| on a supported `Hardware platform <../Release_Specific_Supported_Platforms_and_Versions.html>`__.
SDK Embedded Linux System |__FEATURINGMATRIX__| on a supported :ref:`Hardware platform <release-specific-supported-platforms-and-versions>`.
This will allow you to poke and prod and interact. It’s a powerful way
to get the imagination active and engaged.

Expand Down
10 changes: 5 additions & 5 deletions source/linux/Overview/_Processor_SDK_Linux_Software_Stack.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.. http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_Software_Stack
.. _linux-software-stack:

************************************
**************
Software Stack
************************************
**************

The following software stack illustrates at a high level the various
components provided with the Processor SDK for Linux.

.. note::
**Availability of certain applications are platform dependent
and clarified in the associated User Guides.**

Availability of certain applications are platform dependent and clarified in the associated User Guides.

.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Launching and Using the TI Apps Launcher

The TI Apps Launcher launches on Linux startup. Follow the below instructions to use it.

1. Flash an SD card with the :file:`tisdk-default-image`. User can download the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|. Please follow the instructions from here to `Flash an SD card <../../linux/Overview/Processor_SDK_Linux_create_SD_card.html>`__.
1. Flash an SD card with the :file:`tisdk-default-image`. User can download the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|. Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.

.. note::

Expand Down Expand Up @@ -130,7 +130,7 @@ ________________________
.. ifconfig:: CONFIG_part_variant in ('AM62X')


1. Ensure you have enabled the camera sensors which you have connected to SK-EVM. Refer `this <../../linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html#enabling-camera-sensors>`__ to know the list of camera modules supported and how to enable the sensor overlays for them.
1. Ensure you have enabled the camera sensors which you have connected to SK-EVM. Refer :ref:`this <enabling-camera-sensors>` to know the list of camera modules supported and how to enable the sensor overlays for them.

2. To launch the Live Camera demo, click on the `Live Camera` button on the left panel.

Expand Down

0 comments on commit be5ca4f

Please sign in to comment.