Skip to content

Bugfix/overview ifconfig #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Bugfix/overview ifconfig #371

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc8744b
fix(overview): remove incorrect ifconfig use
StaticRocket Jul 12, 2025
a6009f8
chore(overview): reduce ifconfig logic
StaticRocket Jul 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 91 additions & 107 deletions source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,123 +8,107 @@

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

+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| **Processor SDK Linux** |
+========================================================================+===============================================================================+
| |___Getting Started Guide___| <-- **Start Here** | |___How To Guides___| |
+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| |___Supported Platforms and Versions___| | |___Building the SDK___| |
+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| |___Directory Structure Overview___| | |___GPLv3 Disclaimer___| |
+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| |___Release Notes___| | |___Migration Guide___| |
+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| |___Technical Support___| | `Training <https://training.ti.com/processor-sdk-training-series>`__ |
+------------------------------------------------------------------------+-------------------------------------------------------------------------------+

.. |___Getting Started Guide___| replace:: :ref:`Getting Started Guide <overview-getting-started>`
.. |___Directory Structure Overview___| replace:: :ref:`Directory Structure Overview <overview-directory-structure>`
.. |___Building the SDK___| replace:: :ref:`Building the SDK with Yocto <overview-building-the-sdk>`
.. |___GPLv3 Disclaimer___| replace:: :ref:`GPLv3 Disclaimer <overview-gplv3-disclaimer>`
.. |___Technical Support___| replace:: :ref:`Technical Support <overview-technical-support>`
.. |___Supported Platforms and Versions___| replace:: :ref:`Supported Platforms and Versions <release-specific-supported-platforms-and-versions>`
.. |___Migration Guide___| replace:: :ref:`Migration Guide <release-specific-migration-guide>`
.. |___How To Guides___| replace:: :ref:`How To Guides <how-to-guides>`
.. |___Release Notes___| replace:: :ref:`Release Notes <Release-note-label>`
.. list-table::
:header-rows: 1

* - Processor SDK Linux
-
* - :ref:`Getting Started Guide <overview-getting-started>` <-- **Start Here**

Check warning on line 16 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 16, "column": 39}}}, "severity": "INFO"}
- :ref:`How To Guides <how-to-guides>`

Check warning on line 17 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 17, "column": 31}}}, "severity": "INFO"}
* - :ref:`Supported Platforms and Versions <release-specific-supported-platforms-and-versions>`

Check warning on line 18 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 18, "column": 50}}}, "severity": "INFO"}
- :ref:`Building the SDK with Yocto <overview-building-the-sdk>`

Check warning on line 19 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 19, "column": 45}}}, "severity": "INFO"}
* - :ref:`Directory Structure Overview <overview-directory-structure>`

Check warning on line 20 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 20, "column": 46}}}, "severity": "INFO"}
- :ref:`GPLv3 Disclaimer <overview-gplv3-disclaimer>`
* - :ref:`Release Notes <Release-note-label>`
- :ref:`Migration Guide <release-specific-migration-guide>`

Check warning on line 23 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 23, "column": 33}}}, "severity": "INFO"}
* - :ref:`Technical Support <overview-technical-support>`

Check warning on line 24 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 24, "column": 35}}}, "severity": "INFO"}
- `Training <https://training.ti.com/processor-sdk-training-series>`__


.. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')

+-----------------------------------------------------------------------+----------------------------------------------------------------------+
| **Processor SDK Linux** | |
+=======================================================================+======================================================================+
| |__Getting Started Guide__| <-- **Start Here** | |__Directory Structure Overview__| |
+-----------------------------------------------------------------------+----------------------------------------------------------------------+
| |__Release Notes__| | |__How To Guides__| |
+-----------------------------------------------------------------------+----------------------------------------------------------------------+
| |__Technical Support__| | |__Building the SDK__| |
+-----------------------------------------------------------------------+----------------------------------------------------------------------+
| |__Linux Software Stack__| | |__GPLv3 Disclaimer__| |
+-----------------------------------------------------------------------+----------------------------------------------------------------------+
| `Training <https://training.ti.com/processor-sdk-training-series>`__ | |
+-----------------------------------------------------------------------+----------------------------------------------------------------------+

.. |__Getting Started Guide__| replace:: :ref:`Getting Started Guide <overview-getting-started>`
.. |__Directory Structure Overview__| replace:: :ref:`Directory Structure Overview <overview-directory-structure>`
.. |__Building the SDK__| replace:: :ref:`Building the SDK with Yocto <overview-building-the-sdk>`
.. |__GPLv3 Disclaimer__| replace:: :ref:`GPLv3 Disclaimer <overview-gplv3-disclaimer>`
.. |__Technical Support__| replace:: :ref:`Technical Support <overview-technical-support>`
.. |__Supported Platforms and Versions__| replace:: :ref:`Supported Platforms and Versions <release-specific-supported-platforms-and-versions>`
.. |__Linux Software Stack__| replace:: :ref:`Linux Software Stack <overview-software-stack>`
.. |__Migration Guide__| replace:: :ref:`Migration Guide <release-specific-migration-guide>`
.. |__How To Guides__| replace:: :ref:`How To Guides <how-to-guides>`
.. |__Release Notes__| replace:: :ref:`Release Notes <Release-note-label>`
.. list-table::
:header-rows: 1

* - Processor SDK Linux
-
* - :ref:`Getting Started Guide <overview-getting-started>` <-- **Start Here**

Check warning on line 35 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 35, "column": 39}}}, "severity": "INFO"}
- :ref:`Directory Structure Overview <overview-directory-structure>`

Check warning on line 36 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 36, "column": 46}}}, "severity": "INFO"}
* - :ref:`Release Notes <Release-note-label>`
- :ref:`How To Guides <how-to-guides>`

Check warning on line 38 in source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst", "range": {"start": {"line": 38, "column": 31}}}, "severity": "INFO"}
* - :ref:`Technical Support <overview-technical-support>`
- :ref:`Building the SDK with Yocto <overview-building-the-sdk>`
* - :ref:`Linux Software Stack <overview-software-stack>`
- :ref:`GPLv3 Disclaimer <overview-gplv3-disclaimer>`
* - `Training <https://training.ti.com/processor-sdk-training-series>`__
-


.. ifconfig:: CONFIG_part_family in ('General_family')

+------------------+------------------------+----------------------------+----------------------------+
| **Foundational Components** (more information on each piece of the distribution) |
+==================+========================+============================+============================+
| |__U-Boot__| | |__Boot Monitor__| | |__Kernel__| | |__Filesystem__| |
+------------------+------------------------+----------------------------+----------------------------+
| |__Tools__| | |__OpenCL__| | |__OpenCV__| | |__Graphics & Display__| |
+------------------+------------------------+----------------------------+----------------------------+
| |__Multimedia__| | |__Examples & Demos__| | |__PRU Subsystem__| | |__Virtualization__| |
+------------------+------------------------+----------------------------+----------------------------+
| |__IPC__| | |__OpenVX__| | |__CMEM__| | |__Machine Learning__| |
+------------------+------------------------+----------------------------+----------------------------+
| |__ATF__| | |__OPTEE__| | | |
+------------------+------------------------+----------------------------+----------------------------+

.. |__Boot Monitor__| replace:: :ref:`Boot Monitor <foundational-components-boot-monitor>`
.. |__OpenCL__| replace:: `OpenCL <http://downloads.ti.com/mctools/esd/docs/opencl/index.html>`__
.. |__OpenCV__| replace:: :ref:`OpenCV <foundational-components-opencv>`
.. |__Multimedia__| replace:: :ref:`Multimedia <foundational-components-multimedia>`
.. |__Virtualization__| replace:: :ref:`Virtualization <foundational-components-virtualization>`
.. |__IPC__| replace:: :ref:`IPC <foundational-components-ipc>`
.. |__OpenVX__| replace:: :ref:`OpenVX <foundational-components-openvx>`
.. |__CMEM__| replace:: :ref:`CMEM <foundational-components-cmem>`
.. |__Machine Learning__| replace:: :ref:`Machine Learning <foundational-components-machine-learning>`
.. |__ATF__| replace:: :ref:`ATF <foundational-components-atf>`
.. |__OPTEE__| replace:: :ref:`OPTEE <foundational-components-optee>`
.. list-table::
:header-rows: 1

* - Foundational Components
-
-
-
* - :ref:`U-Boot <foundational-components-u-boot>`
- :ref:`Boot Monitor <foundational-components-boot-monitor>`
- :ref:`Kernel <foundational-components-kernel>`
- :ref:`Filesystem <foundational-components-filesystem>`
* - :ref:`Tools <foundational-components-tools>`
- `OpenCL <http://downloads.ti.com/mctools/esd/docs/opencl/index.html>`__
- :ref:`OpenCV <foundational-components-opencv>`
- :ref:`Graphics & Display <foundational-components-graphics-and-display>`
* - :ref:`Multimedia <foundational-components-multimedia>`
- :ref:`Examples, Demos <examples-and-demos>`
- :ref:`PRU Subsystem <foundational-components-pru-subsystem>`
- :ref:`Virtualization <foundational-components-virtualization>`
* - :ref:`IPC <foundational-components-ipc>`
- :ref:`OpenVX <foundational-components-openvx>`
- :ref:`CMEM <foundational-components-cmem>`
- :ref:`Machine Learning <foundational-components-machine-learning>`
* - :ref:`ATF <foundational-components-atf>`
- :ref:`OPTEE <foundational-components-optee>`
-
-


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

+--------------------------+------------------------+----------------------------+-------------+
| **Foundational Components** (more information on each piece of the distribution) |
+==========================+========================+============================+=============+
| |__U-Boot__| | |__Kernel__| | |__Filesystem__| | |__Tools__| |
+--------------------------+------------------------+----------------------------+-------------+
| |__Graphics & Display__| | |__Examples & Demos__| | |__PRU Subsystem__| | |
+--------------------------+------------------------+----------------------------+-------------+

.. |__U-Boot__| replace:: :ref:`U-Boot <foundational-components-u-boot>`
.. |__Kernel__| replace:: :ref:`Kernel <foundational-components-kernel>`
.. |__Filesystem__| replace:: :ref:`Filesystem <foundational-components-filesystem>`
.. |__Tools__| replace:: :ref:`Tools <foundational-components-tools>`
.. |__Graphics & Display__| replace:: :ref:`Graphics & Display <foundational-components-graphics-and-display>`
.. |__Examples & Demos__| replace:: :ref:`Examples, Demos <examples-and-demos>`
.. |__PRU Subsystem__| replace:: :ref:`PRU Subsystem <foundational-components-pru-subsystem>`


.. ifconfig:: CONFIG_sdk in ('SITARA')
.. list-table::
:header-rows: 1

* - Foundational Components
-
-
-
* - :ref:`U-Boot <foundational-components-u-boot>`
- :ref:`Kernel <foundational-components-kernel>`
- :ref:`Filesystem <foundational-components-filesystem>`
- :ref:`Tools <foundational-components-tools>`
* - :ref:`Graphics & Display <foundational-components-graphics-and-display>`
- :ref:`Examples, Demos <examples-and-demos>`
- :ref:`PRU Subsystem <foundational-components-pru-subsystem>`
-


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

.. list-table::
:header-rows: 1

* - PRU-ICSS / PRU_ICSSG Protocols
-
-
-
* - :ref:`DUAL_EMAC <industrial-protocols-dual-emac>`
- :ref:`HSR_PRP <industrial-protocols-hsr-prp>`
- :ref:`PTP <industrial-protocols-ptp>`
- :ref:`RSTP <industrial-protocols-rstp>`
* - :ref:`CCLINK <industrial-protocols-cclink>`
- :ref:`SORTE <industrial-protocols-sorte>`
- :ref:`OPC/UA <industrial-protocols-opcua>`
-

.. ifconfig:: CONFIG_part_variant not in ('AM62LX', 'AM62X', 'AM62AX', 'AM62PX', 'AM335X', 'AM437X', 'AM65X')

+-----------------+------------------------+------------------+-----------------------------------+
| **PRU-ICSS / PRU_ICSSG Protocols** (more information on each piece of the distribution) |
+=================+========================+==================+===================================+
| |__DUAL_EMAC__| | |__HSR_PRP__| | |__PTP__| | |__RSTP__| |
+-----------------+------------------------+------------------+-----------------------------------+
| |__CCLINK__| | |__SORTE__| | |__OPCUA__| | |
+-----------------+------------------------+------------------+-----------------------------------+

.. |__DUAL_EMAC__| replace:: :ref:`DUAL_EMAC <industrial-protocols-dual-emac>`
.. |__HSR_PRP__| replace:: :ref:`HSR_PRP <industrial-protocols-hsr-prp>`
.. |__PTP__| replace:: :ref:`PTP <industrial-protocols-ptp>`
.. |__RSTP__| replace:: :ref:`RSTP <industrial-protocols-rstp>`
.. |__CCLINK__| replace:: :ref:`CCLINK <industrial-protocols-cclink>`
.. |__SORTE__| replace:: :ref:`SORTE <industrial-protocols-sorte>`
.. |__OPCUA__| replace:: :ref:`OPC/UA <industrial-protocols-opcua>`
Loading