From fc8744bb6ffe6d72d3c24be7ef923a39d159ec4d Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Sat, 12 Jul 2025 12:52:59 -0500 Subject: [PATCH 1/2] fix(overview): remove incorrect ifconfig use Remove the last of the incorrect usage of the ifconfig directive. Replace these cumbersome tables with list-tables. This is a little goofy due to old formatting. To keep in line with what was previously here (and to prevent automatic numbering of these tables), we must place the header in the first row and pad accordingly. Signed-off-by: Randolph Sapp --- ...or_SDK_Linux_Software_Developers_Guide.rst | 193 ++++++++---------- 1 file changed, 90 insertions(+), 103 deletions(-) diff --git a/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst b/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst index 2bc4501e0..c81cd3488 100644 --- a/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst +++ b/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst @@ -8,123 +8,110 @@ suggestions at `E2E `__. .. 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 `__ | - +------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - - .. |___Getting Started Guide___| replace:: :ref:`Getting Started Guide ` - .. |___Directory Structure Overview___| replace:: :ref:`Directory Structure Overview ` - .. |___Building the SDK___| replace:: :ref:`Building the SDK with Yocto ` - .. |___GPLv3 Disclaimer___| replace:: :ref:`GPLv3 Disclaimer ` - .. |___Technical Support___| replace:: :ref:`Technical Support ` - .. |___Supported Platforms and Versions___| replace:: :ref:`Supported Platforms and Versions ` - .. |___Migration Guide___| replace:: :ref:`Migration Guide ` - .. |___How To Guides___| replace:: :ref:`How To Guides ` - .. |___Release Notes___| replace:: :ref:`Release Notes ` + .. list-table:: + :header-rows: 1 + + * - Processor SDK Linux + - + * - :ref:`Getting Started Guide ` <-- **Start Here** + - :ref:`How To Guides ` + * - :ref:`Supported Platforms and Versions ` + - :ref:`Building the SDK with Yocto ` + * - :ref:`Directory Structure Overview ` + - :ref:`GPLv3 Disclaimer ` + * - :ref:`Release Notes ` + - :ref:`Migration Guide ` + * - :ref:`Technical Support ` + - `Training `__ .. 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 `__ | | - +-----------------------------------------------------------------------+----------------------------------------------------------------------+ - - .. |__Getting Started Guide__| replace:: :ref:`Getting Started Guide ` - .. |__Directory Structure Overview__| replace:: :ref:`Directory Structure Overview ` - .. |__Building the SDK__| replace:: :ref:`Building the SDK with Yocto ` - .. |__GPLv3 Disclaimer__| replace:: :ref:`GPLv3 Disclaimer ` - .. |__Technical Support__| replace:: :ref:`Technical Support ` - .. |__Supported Platforms and Versions__| replace:: :ref:`Supported Platforms and Versions ` - .. |__Linux Software Stack__| replace:: :ref:`Linux Software Stack ` - .. |__Migration Guide__| replace:: :ref:`Migration Guide ` - .. |__How To Guides__| replace:: :ref:`How To Guides ` - .. |__Release Notes__| replace:: :ref:`Release Notes ` + .. list-table:: + :header-rows: 1 + + * - Processor SDK Linux + - + * - :ref:`Getting Started Guide ` <-- **Start Here** + - :ref:`Directory Structure Overview ` + * - :ref:`Release Notes ` + - :ref:`How To Guides ` + * - :ref:`Technical Support ` + - :ref:`Building the SDK with Yocto ` + * - :ref:`Linux Software Stack ` + - :ref:`GPLv3 Disclaimer ` + * - `Training `__ + - .. 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 ` - .. |__OpenCL__| replace:: `OpenCL `__ - .. |__OpenCV__| replace:: :ref:`OpenCV ` - .. |__Multimedia__| replace:: :ref:`Multimedia ` - .. |__Virtualization__| replace:: :ref:`Virtualization ` - .. |__IPC__| replace:: :ref:`IPC ` - .. |__OpenVX__| replace:: :ref:`OpenVX ` - .. |__CMEM__| replace:: :ref:`CMEM ` - .. |__Machine Learning__| replace:: :ref:`Machine Learning ` - .. |__ATF__| replace:: :ref:`ATF ` - .. |__OPTEE__| replace:: :ref:`OPTEE ` + .. list-table:: + :header-rows: 1 + + * - Foundational Components + - + - + - + * - :ref:`U-Boot ` + - :ref:`Boot Monitor ` + - :ref:`Kernel ` + - :ref:`Filesystem ` + * - :ref:`Tools ` + - `OpenCL `__ + - :ref:`OpenCV ` + - :ref:`Graphics & Display ` + * - :ref:`Multimedia ` + - :ref:`Examples, Demos ` + - :ref:`PRU Subsystem ` + - :ref:`Virtualization ` + * - :ref:`IPC ` + - :ref:`OpenVX ` + - :ref:`CMEM ` + - :ref:`Machine Learning ` + * - :ref:`ATF ` + - :ref:`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__| | | - +--------------------------+------------------------+----------------------------+-------------+ + .. list-table:: + :header-rows: 1 - .. |__U-Boot__| replace:: :ref:`U-Boot ` - .. |__Kernel__| replace:: :ref:`Kernel ` - .. |__Filesystem__| replace:: :ref:`Filesystem ` - .. |__Tools__| replace:: :ref:`Tools ` - .. |__Graphics & Display__| replace:: :ref:`Graphics & Display ` - .. |__Examples & Demos__| replace:: :ref:`Examples, Demos ` - .. |__PRU Subsystem__| replace:: :ref:`PRU Subsystem ` + * - Foundational Components + - + - + - + * - :ref:`U-Boot ` + - :ref:`Kernel ` + - :ref:`Filesystem ` + - :ref:`Tools ` + * - :ref:`Graphics & Display ` + - :ref:`Examples, Demos ` + - :ref:`PRU Subsystem ` + - .. ifconfig:: CONFIG_sdk in ('SITARA') - .. 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 ` - .. |__HSR_PRP__| replace:: :ref:`HSR_PRP ` - .. |__PTP__| replace:: :ref:`PTP ` - .. |__RSTP__| replace:: :ref:`RSTP ` - .. |__CCLINK__| replace:: :ref:`CCLINK ` - .. |__SORTE__| replace:: :ref:`SORTE ` - .. |__OPCUA__| replace:: :ref:`OPC/UA ` + .. ifconfig:: CONFIG_part_variant not in ('AM62LX', 'AM62X', 'AM62AX', 'AM62PX', 'AM335X', 'AM437X', 'AM65X') + + .. list-table:: + :header-rows: 1 + + * - PRU-ICSS / PRU_ICSSG Protocols + - + - + - + * - :ref:`DUAL_EMAC ` + - :ref:`HSR_PRP ` + - :ref:`PTP ` + - :ref:`RSTP ` + * - :ref:`CCLINK ` + - :ref:`SORTE ` + - :ref:`OPC/UA ` + - + + From a6009f892183cb0f58853b65c2a28f46a681f135 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Sat, 12 Jul 2025 13:20:37 -0500 Subject: [PATCH 2/2] chore(overview): reduce ifconfig logic This was needlessly complicated. Reduce to the only platforms that were affected based on previous logic. Signed-off-by: Randolph Sapp --- ...or_SDK_Linux_Software_Developers_Guide.rst | 33 +++++++++---------- 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst b/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst index c81cd3488..9dc456054 100644 --- a/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst +++ b/source/linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst @@ -94,24 +94,21 @@ suggestions at `E2E `__. - -.. ifconfig:: CONFIG_sdk in ('SITARA') - - .. ifconfig:: CONFIG_part_variant not in ('AM62LX', 'AM62X', 'AM62AX', 'AM62PX', 'AM335X', 'AM437X', 'AM65X') - - .. list-table:: - :header-rows: 1 +.. ifconfig:: CONFIG_part_variant in ('AM64X') - * - PRU-ICSS / PRU_ICSSG Protocols - - - - - - - * - :ref:`DUAL_EMAC ` - - :ref:`HSR_PRP ` - - :ref:`PTP ` - - :ref:`RSTP ` - * - :ref:`CCLINK ` - - :ref:`SORTE ` - - :ref:`OPC/UA ` - - + .. list-table:: + :header-rows: 1 + * - PRU-ICSS / PRU_ICSSG Protocols + - + - + - + * - :ref:`DUAL_EMAC ` + - :ref:`HSR_PRP ` + - :ref:`PTP ` + - :ref:`RSTP ` + * - :ref:`CCLINK ` + - :ref:`SORTE ` + - :ref:`OPC/UA ` + -