Skip to content

Commit 35a1365

Browse files
jeevantelukulajeevantelukula
committed
fix: Refactor Yocto config files to follow sphinx guidelines
Move from grid tables to list tables for Yocto layer configuration files. Also move to using code blocks. Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
1 parent 73bfa02 commit 35a1365

8 files changed

+159
-106
lines changed

‎source/devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
.. _yocto-layer-configuration:
22

3-
**************************
3+
#########################
44
Yocto Layer Configuration
5-
**************************
5+
#########################
66

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

9-
Processor SDK uses the following oe-layersetup configs to configure the
10-
meta layers. These are the <config> used in the command:
10+
.. code-block:: console
1111
12-
``$ ./oe-layertool-setup.sh -f <config>``
12+
$ ./oe-layertool-setup.sh -f <config>
1313
14-
|
15-
| The following config files are located in the **yocto-build/configs/processor-sdk-linux**
16-
directory.
14+
Replace ``<config>`` with one of the configuration files listed below.
1715

18-
+-------------------------------------+----------------------------------------------------+--------------------------------+
19-
| Config File | Description | Supported machines |
20-
+=====================================+====================================================+================================+
21-
| processor-sdk-linux-11_01_02_01.txt | Processor SDK Linux 11_01 Release | am57xx-evm, am57xx-hs-evm |
22-
+-------------------------------------+----------------------------------------------------+--------------------------------+
16+
The :file:`yocto-build/configs/processor-sdk-linux` directory contains the following configuration files.
17+
18+
.. list-table:: Yocto Layer Configuration
19+
:widths: 50 50 30
20+
:header-rows: 1
21+
22+
* - Config File
23+
- Description
24+
- Supported machines/platforms
25+
* - :file:`processor-sdk-linux-11_01_02_01.txt`
26+
- Processor SDK Linux 11_01 Release
27+
- |__SDK_BUILD_MACHINE__|, am57xx-hs-evm

‎source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
.. _yocto-layer-configuration:
22

3-
*************************
3+
#########################
44
Yocto Layer Configuration
5-
*************************
5+
#########################
66

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

1010
.. code-block:: console
1111
1212
$ ./oe-layertool-setup.sh -f <config>
1313
14-
The following config files are located in the :file:`configs/processor-sdk-analytics`
15-
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
14+
Replace ``<config>`` with one of the configuration files listed below.
1615

17-
+-------------------------------------------------------------------+------------------------------------------------------+------------------------------+
18-
| Config File | Description | Supported machines/platforms |
19-
+===================================================================+======================================================+==============================+
20-
| processor-sdk-analytics-11.01.07.05-config.txt | Used for building EdgeAI filesystem | am62axx-evm |
21-
+-------------------------------------------------------------------+------------------------------------------------------+------------------------------+
22-
| processor-sdk-analytics-selinux-11.01.07.05-config.txt | Used for building SELinux enabled EdgeAI filesystem | am62axx-evm |
23-
+-------------------------------------------------------------------+------------------------------------------------------+------------------------------+
16+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
17+
contains the following configuration files in the :file:`configs/processor-sdk` directory.
18+
19+
.. list-table:: Yocto Layer Configuration
20+
:widths: 50 50 30
21+
:header-rows: 1
22+
23+
* - Config File
24+
- Description
25+
- Supported machines/platforms
26+
* - :file:`processor-sdk-analytics-11.01.07.05-config.txt`
27+
- Used for building EdgeAI filesystem
28+
- |__SDK_BUILD_MACHINE__|
29+
* - :file:`processor-sdk-analytics-selinux-11.01.07.05-config.txt`
30+
- Used for building SELinux enabled EdgeAI filesystem
31+
- |__SDK_BUILD_MACHINE__|
2432

2533
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__|.

‎source/devices/AM62DX/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
.. _yocto-layer-configuration:
22

3-
*************************
3+
#########################
44
Yocto Layer Configuration
5-
*************************
5+
#########################
66

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

1010
.. code-block:: console
1111
1212
$ ./oe-layertool-setup.sh -f <config>
1313
14-
The following config files are located in the ``configs/processor-sdk``
15-
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
14+
Replace ``<config>`` with one of the configuration files listed below.
1615

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

19+
.. list-table:: Yocto Layer Configuration
20+
:widths: 50 50 30
21+
:header-rows: 1
22+
23+
* - Config File
24+
- Description
25+
- Supported machines/platforms
26+
* - :file:`processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt`
27+
- Used for building Yocto based filesystem
28+
- |__SDK_BUILD_MACHINE__|

‎source/devices/AM62LX/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
.. _yocto-layer-configuration:
22

3-
*************************
3+
#########################
44
Yocto Layer Configuration
5-
*************************
5+
#########################
66

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

1010
.. code-block:: console
1111
1212
$ ./oe-layertool-setup.sh -f <config>
1313
14-
The following config files are located in the ``configs/processor-sdk``
15-
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
14+
Replace ``<config>`` with one of the configuration files listed below.
1615

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

19+
.. list-table:: Yocto Layer Configuration
20+
:widths: 50 50 30
21+
:header-rows: 1
22+
23+
* - Config File
24+
- Description
25+
- Supported machines/platforms
26+
* - :file:`processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt`
27+
- Used for building Yocto based filesystem
28+
- |__SDK_BUILD_MACHINE__|

‎source/devices/AM62PX/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,36 @@
11
.. _yocto-layer-configuration:
22

3-
*************************
3+
#########################
44
Yocto Layer Configuration
5-
*************************
5+
#########################
66

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

1010
.. code-block:: console
1111
1212
$ ./oe-layertool-setup.sh -f <config>
1313
14-
The following config files are located in the ``configs/processor-sdk``
15-
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
14+
Replace ``<config>`` with one of the configuration files listed below.
1615

17-
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
18-
| Config File | Description | Supported machines/platforms |
19-
+===============================================================+===================================+===============================+
20-
| processor-sdk-scarthgap-chromium-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
21-
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
22-
| processor-sdk-scarthgap-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
23-
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
24-
| processor-sdk-scarthgap-selinux-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | |__SDK_BUILD_MACHINE__| |
25-
+---------------------------------------------------------------+-----------------------------------+-------------------------------+
16+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
17+
contains the following configuration files in the :file:`configs/processor-sdk` directory.
2618

27-
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__|.
19+
.. list-table:: Yocto Layer Configuration
20+
:widths: 50 50 30
21+
:header-rows: 1
22+
23+
* - Config File
24+
- Description
25+
- Supported machines/platforms
26+
* - :file:`processor-sdk-scarthgap-chromium-11.02.08.02-config.txt`
27+
- Used for building chromium browser enabled Yocto based filesystem
28+
- |__SDK_BUILD_MACHINE__|
29+
* - :file:`processor-sdk-scarthgap-11.02.08.02-config.txt`
30+
- Used for building Yocto based filesystem
31+
- |__SDK_BUILD_MACHINE__|
32+
* - :file:`processor-sdk-scarthgap-selinux-11.02.08.02-config.txt`
33+
- Used for building SELinux enabled Yocto based filesystem
34+
- |__SDK_BUILD_MACHINE__|
2835

36+
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__|.

‎source/devices/AM62X/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,36 @@
11
.. _yocto-layer-configuration:
22

3-
*************************
3+
#########################
44
Yocto Layer Configuration
5-
*************************
5+
#########################
66

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

1010
.. code-block:: console
1111
1212
$ ./oe-layertool-setup.sh -f <config>
1313
14-
The following config files are located in the ``configs/processor-sdk``
15-
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
16-
17-
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
18-
| Config File | Description | Supported machines/platforms |
19-
+===================================================================+===================================+==========================================================+
20-
| processor-sdk-scarthgap-chromium-11.02.08.02-config.txt | Processor SDK 11.02.08.02 Release | am62xx-evm, am62xx-lp-evm, beagleplay-ti |
21-
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
22-
| 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 |
23-
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
24-
| 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 |
25-
+-------------------------------------------------------------------+-----------------------------------+----------------------------------------------------------+
14+
Replace ``<config>`` with one of the configuration files listed below.
15+
16+
The `oe-layersetup git repository <https://git.ti.com/cgit/arago-project/oe-layersetup/>`__
17+
contains the following configuration files in the :file:`configs/processor-sdk` directory.
18+
19+
.. list-table:: Yocto Layer Configuration
20+
:widths: 40 40 40
21+
:header-rows: 1
22+
23+
* - Config File
24+
- Description
25+
- Supported machines/platforms
26+
* - :file:`processor-sdk-scarthgap-chromium-11.02.08.02-config.txt`
27+
- Used for building chromium browser enabled Yocto based filesystem
28+
- |__SDK_BUILD_MACHINE__|, am62xx-lp-evm, beagleplay-ti
29+
* - :file:`processor-sdk-scarthgap-11.02.08.02-config.txt`
30+
- Used for building Yocto based filesystem
31+
- |__SDK_BUILD_MACHINE__|, am62xx-lp-evm, am62xxsip-evm, beagleplay-ti
32+
* - :file:`processor-sdk-scarthgap-selinux-11.02.08.02-config.txt`
33+
- Used for building SELinux enabled Yocto based filesystem
34+
- |__SDK_BUILD_MACHINE__|, am62xx-lp-evm, am62xxsip-evm, beagleplay-ti
2635

2736
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__|.

‎source/devices/AM64X/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
.. _yocto-layer-configuration:
22

3-
*************************
3+
#########################
44
Yocto Layer Configuration
5-
*************************
5+
#########################
66

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

1010
.. code-block:: console
1111
1212
$ ./oe-layertool-setup.sh -f <config>
1313
14-
The following config files are located in the ``configs/processor-sdk``
15-
directory of the `oe-layersetup git repo <https://git.ti.com/cgit/arago-project/oe-layersetup/>`_.
14+
Replace ``<config>`` with one of the configuration files listed below.
1615

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

19+
.. list-table:: Yocto Layer Configuration
20+
:widths: 50 50 30
21+
:header-rows: 1
22+
23+
* - Config File
24+
- Description
25+
- Supported machines/platforms
26+
* - :file:`processor-sdk-scarthgap-nonqt-11.02.08.02-config.txt`
27+
- Used for building Yocto based filesystem
28+
- |__SDK_BUILD_MACHINE__|

‎source/devices/DRA821A/linux/Release_Specific_Yocto_layer_Configuration.rst‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
.. _yocto-layer-configuration:
22

3-
**************************
3+
#########################
44
Yocto Layer Configuration
5-
**************************
5+
#########################
66

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

9-
Processor SDK uses the following oe-layersetup configs to configure the
10-
meta layers. These are the <config> used in the command:
10+
.. code-block:: console
1111
12-
``$ ./oe-layertool-setup.sh -f <config>``
12+
$ ./oe-layertool-setup.sh -f <config>
1313
14-
|
15-
| The following config files are located in the **yocto-build/configs/processor-sdk-linux**
16-
directory.
14+
Replace ``<config>`` with one of the configuration files listed below.
1715

18-
+-------------------------------------+----------------------------------------------------+--------------------------------+
19-
| Config File | Description | Supported machines |
20-
+=====================================+====================================================+================================+
21-
| processor-sdk-linux-07_03_00.txt | Processor SDK Linux 07_03_00 Release | j7200-evm |
22-
+-------------------------------------+----------------------------------------------------+--------------------------------+
16+
The :file:`yocto-build/configs/processor-sdk-linux` directory contains the following configuration files.
17+
18+
.. list-table:: Yocto Layer Configuration
19+
:widths: 50 50 30
20+
:header-rows: 1
21+
22+
* - Config File
23+
- Description
24+
- Supported machines/platforms
25+
* - :file:`processor-sdk-linux-07_03_00.txt`
26+
- Processor SDK Linux 07_03_00 Release
27+
- |__SDK_BUILD_MACHINE__|

0 commit comments

Comments
 (0)