Skip to content

fix: Refactor Yocto config files as per sphinx guidelines #596

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

Merged
StaticRocket merged 1 commit into from
Dec 19, 2025
Merged

fix: Refactor Yocto config files as per sphinx guidelines #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 19 additions & 14 deletions source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
.. _yocto-layer-configuration:

**************************
#########################
Yocto Layer Configuration
**************************
#########################

.. http://processors.wiki.ti.com/index.php/Processor_SDK_Building_The_SDK#Layer_Configuration
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
.. code-block:: console

``$ ./oe-layertool-setup.sh -f <config>``
$ ./oe-layertool-setup.sh -f <config>

|
| The following config files are located in the **yocto-build/configs/processor-sdk-linux**
directory.
Replace ``<config>`` with one of the following configuration files.

+-------------------------------------+----------------------------------------------------+--------------------------------+
| Config File | Description | Supported machines |
+=====================================+====================================================+================================+
| processor-sdk-linux-11_01_02_01.txt | Processor SDK Linux 11_01 Release | am57xx-evm, am57xx-hs-evm |
+-------------------------------------+----------------------------------------------------+--------------------------------+
The :file:`yocto-build/configs/processor-sdk-linux` directory has the following configuration files.

Check warning on line 16 in source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.", "location": {"path": "source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 16, "column": 46}}}, "severity": "WARNING"}

Check warning on line 16 in source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'build/configs'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'build/configs'", "location": {"path": "source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 16, "column": 18}}}, "severity": "WARNING"}

.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-linux-11_01_02_01.txt`

Check warning on line 25 in source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.", "location": {"path": "source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 25, "column": 29}}}, "severity": "WARNING"}
- Processor SDK Linux 11_01 Release
- |__SDK_BUILD_MACHINE__|, am57xx-hs-evm
34 changes: 21 additions & 13 deletions source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
.. _yocto-layer-configuration:

*************************
#########################
Yocto Layer Configuration
*************************
#########################

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

.. code-block:: console

$ ./oe-layertool-setup.sh -f <config>

The following config files are located in the :file:`configs/processor-sdk-analytics`
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
Replace ``<config>`` with one of the following configuration files.

+-------------------------------------------------------------------+------------------------------------------------------+------------------------------+
| Config File | Description | Supported machines/platforms |
+===================================================================+======================================================+==============================+
| processor-sdk-analytics-11.01.07.05-config.txt | Used for building EdgeAI filesystem | am62axx-evm |
+-------------------------------------------------------------------+------------------------------------------------------+------------------------------+
| processor-sdk-analytics-selinux-11.01.07.05-config.txt | Used for building SELinux enabled EdgeAI filesystem | am62axx-evm |
+-------------------------------------------------------------------+------------------------------------------------------+------------------------------+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
has the following configuration files in the :file:`configs/processor-sdk` directory.

Check warning on line 17 in source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'", "location": {"path": "source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 17, "column": 53}}}, "severity": "WARNING"}

.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-analytics-11.01.07.05-config.txt`
- Used for building EdgeAI filesystem
- |__SDK_BUILD_MACHINE__|
* - :file:`processor-sdk-analytics-selinux-11.01.07.05-config.txt`

Check warning on line 29 in source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'SELinux' rather than 'selinux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'SELinux' rather than 'selinux'.", "location": {"path": "source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 29, "column": 39}}}, "severity": "WARNING"}
- Used for building SELinux enabled EdgeAI filesystem
- |__SDK_BUILD_MACHINE__|

The oe-layersetup configuration, as defined in :file:`processor-sdk-analytics-11.01.07.05-config.txt` is used for configuring the meta layers in the yocto SD card image available on |__SDK_DOWNLOAD_URL__|.
28 changes: 17 additions & 11 deletions source/devices/AM62DX/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
.. _yocto-layer-configuration:

*************************
#########################
Yocto Layer Configuration
*************************
#########################

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

.. code-block:: console

$ ./oe-layertool-setup.sh -f <config>

The following config files are located in the ``configs/processor-sdk``
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
Replace ``<config>`` with one of the following configuration files.

+---------------------------------------------------------------+-----------------------------------+-------------------------------+
| Config File | Description | Supported machines/platforms |
+===============================================================+===================================+===============================+
| processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | am62dxx-evm |
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
has the following configuration files in the :file:`configs/processor-sdk` directory.

Check warning on line 17 in source/devices/AM62DX/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'", "location": {"path": "source/devices/AM62DX/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 17, "column": 53}}}, "severity": "WARNING"}

.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt`
- Used for building Yocto based filesystem
- |__SDK_BUILD_MACHINE__|
28 changes: 17 additions & 11 deletions source/devices/AM62LX/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
.. _yocto-layer-configuration:

*************************
#########################
Yocto Layer Configuration
*************************
#########################

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

.. code-block:: console

$ ./oe-layertool-setup.sh -f <config>

The following config files are located in the ``configs/processor-sdk``
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
Replace ``<config>`` with one of the following configuration files.

+---------------------------------------------------------------+-----------------------------------+-------------------------------+
| Config File | Description | Supported machines/platforms |
+===============================================================+===================================+===============================+
| processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
has the following configuration files in the :file:`configs/processor-sdk` directory.

Check warning on line 17 in source/devices/AM62LX/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'", "location": {"path": "source/devices/AM62LX/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 17, "column": 53}}}, "severity": "WARNING"}

.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt`
- Used for building Yocto based filesystem
- |__SDK_BUILD_MACHINE__|
40 changes: 24 additions & 16 deletions source/devices/AM62PX/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
.. _yocto-layer-configuration:

*************************
#########################
Yocto Layer Configuration
*************************
#########################

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

.. code-block:: console

$ ./oe-layertool-setup.sh -f <config>

The following config files are located in the ``configs/processor-sdk``
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
Replace ``<config>`` with one of the following configuration files.

+---------------------------------------------------------------+-----------------------------------+-------------------------------+
| Config File | Description | Supported machines/platforms |
+===============================================================+===================================+===============================+
| processor-sdk-scarthgap-chromium-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
| processor-sdk-scarthgap-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
| processor-sdk-scarthgap-selinux-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
has the following configuration files in the :file:`configs/processor-sdk` directory.

Check warning on line 17 in source/devices/AM62PX/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'", "location": {"path": "source/devices/AM62PX/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 17, "column": 53}}}, "severity": "WARNING"}

The oe-layersetup configuration, as defined in ``processor-sdk-scarthgap-chromium-11.02.08.02-config.txt``, is used for configuring the meta layers in the yocto SD card image available on |__SDK_DOWNLOAD_URL__|.
.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-scarthgap-chromium-11.02.08.02-config.txt`
- Used for building chromium browser enabled Yocto based filesystem
- |__SDK_BUILD_MACHINE__|
* - :file:`processor-sdk-scarthgap-11.02.08.02-config.txt`
- Used for building Yocto based filesystem
- |__SDK_BUILD_MACHINE__|
* - :file:`processor-sdk-scarthgap-selinux-11.02.08.02-config.txt`

Check warning on line 32 in source/devices/AM62PX/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'SELinux' rather than 'selinux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'SELinux' rather than 'selinux'.", "location": {"path": "source/devices/AM62PX/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 32, "column": 39}}}, "severity": "WARNING"}
- Used for building SELinux enabled Yocto based filesystem
- |__SDK_BUILD_MACHINE__|

The oe-layersetup configuration, as defined in ``processor-sdk-scarthgap-chromium-11.02.08.02-config.txt``, is used for configuring the meta layers in the yocto SD card image available on |__SDK_DOWNLOAD_URL__|.
41 changes: 25 additions & 16 deletions source/devices/AM62X/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,36 @@
.. _yocto-layer-configuration:

*************************
#########################
Yocto Layer Configuration
*************************
#########################

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

.. code-block:: console

$ ./oe-layertool-setup.sh -f <config>

The following config files are located in the ``configs/processor-sdk``
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.

+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
| Config File | Description | Supported machines/platforms |
+===================================================================+===================================+==========================================================+
| processor-sdk-scarthgap-chromium-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | am62xx-evm, am62xx-lp-evm, beagleplay-ti |
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
| processor-sdk-scarthgap-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | am62xx-evm, am62xx-lp-evm, am62xxsip-evm, beagleplay-ti |
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
| processor-sdk-scarthgap-selinux-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | am62xx-evm, am62xx-lp-evm, am62xxsip-evm, beagleplay-ti |
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
Replace ``<config>`` with one of the following configuration files.

The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
has the following configuration files in the :file:`configs/processor-sdk` directory.

Check warning on line 17 in source/devices/AM62X/linux/Release_Specific_Yocto_layer_Configuration.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'configs/processor'", "location": {"path": "source/devices/AM62X/linux/Release_Specific_Yocto_layer_Configuration.rst", "range": {"start": {"line": 17, "column": 53}}}, "severity": "WARNING"}

.. list-table:: Yocto Layer Configuration
:widths: 40 40 40
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-scarthgap-chromium-11.02.08.02-config.txt`
- Used for building chromium browser enabled Yocto based filesystem
- |__SDK_BUILD_MACHINE__|, am62xx-lp-evm, beagleplay-ti
* - :file:`processor-sdk-scarthgap-11.02.08.02-config.txt`
- Used for building Yocto based filesystem
- |__SDK_BUILD_MACHINE__|, am62xx-lp-evm, am62xxsip-evm, beagleplay-ti
* - :file:`processor-sdk-scarthgap-selinux-11.02.08.02-config.txt`
- Used for building SELinux enabled Yocto based filesystem
- |__SDK_BUILD_MACHINE__|, am62xx-lp-evm, am62xxsip-evm, beagleplay-ti

The oe-layersetup configuration, as defined in ``processor-sdk-scarthgap-chromium-11.02.08.02-config.txt``, is used for configuring the meta layers in the yocto SD card image available on |__SDK_DOWNLOAD_URL__|.
28 changes: 17 additions & 11 deletions source/devices/AM64X/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
.. _yocto-layer-configuration:

*************************
#########################
Yocto Layer Configuration
*************************
#########################

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

.. code-block:: console

$ ./oe-layertool-setup.sh -f <config>

The following config files are located in the ``configs/processor-sdk``
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
Replace ``<config>`` with one of the following configuration files.

+--------------------------------------------------------+-----------------------------------+------------------------------+
| Config File | Description | Supported machines/platforms |
+========================================================+===================================+==============================+
| processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | am64xx-evm |
+--------------------------------------------------------+-----------------------------------+------------------------------+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
has the following configuration files in the :file:`configs/processor-sdk` directory.

.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt`
- Used for building Yocto based filesystem
- |__SDK_BUILD_MACHINE__|
33 changes: 19 additions & 14 deletions source/devices/DRA821A/linux/Release_Specific_Yocto_layer_Configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
.. _yocto-layer-configuration:

**************************
#########################
Yocto Layer Configuration
**************************
#########################

.. http://processors.wiki.ti.com/index.php/Processor_SDK_Building_The_SDK#Layer_Configuration
Processor SDK uses oe-layersetup configuration files to initialize the
Yocto build environment. Configure your build with the following command:

Processor SDK uses the following oe-layersetup configs to configure the
meta layers. These are the <config> used in the command:
.. code-block:: console

``$ ./oe-layertool-setup.sh -f <config>``
$ ./oe-layertool-setup.sh -f <config>

|
| The following config files are located in the **yocto-build/configs/processor-sdk-linux**
directory.
Replace ``<config>`` with one of the following configuration files.

+-------------------------------------+----------------------------------------------------+--------------------------------+
| Config File | Description | Supported machines |
+=====================================+====================================================+================================+
| processor-sdk-linux-07_03_00.txt | Processor SDK Linux 07_03_00 Release | j7200-evm |
+-------------------------------------+----------------------------------------------------+--------------------------------+
The :file:`yocto-build/configs/processor-sdk-linux` directory has the following configuration files.

.. list-table:: Yocto Layer Configuration
:widths: 50 50 30
:header-rows: 1

* - Config File
- Description
- Supported machines/platforms
* - :file:`processor-sdk-linux-07_03_00.txt`
- Processor SDK Linux 07_03_00 Release
- |__SDK_BUILD_MACHINE__|
Loading