Skip to content

Commit 30b6235

Browse files
committed
docs(debian): Mass update debian docs for 11.01.16.13 release
First passthrough updating debian docs, more to come in future. Added release notes, fixed formatting, and updated some content. Updates following Oct 2025 AM62Px PG1.2 and AM62Lx PG1.1 release. Signed-off-by: Jonas Wood <[email protected]>
1 parent 64cf395 commit 30b6235

18 files changed

+427
-194
lines changed

configs/AM62LX/AM62LX_debian_config.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@
1313

1414
Replacement Variables
1515
---------------------
16-
'__PART_FAMILY_NAME__' : 'AM62LX'
17-
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62LX'
16+
'__PART_FAMILY_NAME__' : 'AM62Lx'
17+
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62Lx'
1818
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
1919
'__SDK_BUILD_MACHINE__' : 'am62lxx-evm'
2020
'__SDK_FULL_NAME__' : 'Debian for AM62L'
2121
'__SDK_SHORT_NAME__' : 'Debian'
22-
'__SDK_DOWNLOAD_URL__' : '`AM62L-SDK-Download-page <https://www.ti.com/tool/AM62L-PROCESSOR-SDK>`__'
22+
'__SDK_DOWNLOAD_URL__' : '`AM62Lx-SDK-Download-page <https://www.ti.com/tool/AM62L-PROCESSOR-SDK>`__'
2323
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
2424
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'
2525

configs/AM62LX/AM62LX_debian_tags.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
fam_name = 'AM62LX'
33

44
# Project name and HTML title
5-
project = u'Debian for AM62LX'
6-
html_title = 'Debian AM62LX Documentation'
5+
project = u'Debian for AM62Lx'
6+
html_title = 'Debian AM62Lx Documentation'
77

88
# The master toctree document.
99
master_doc = 'devices/AM62LX/debian/index'

configs/AM62LX/AM62LX_debian_toc.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
devices/AM62LX/debian/index
22

33
debian/Overview
4+
devices/AM62LX/debian/Release_Specific
5+
devices/AM62LX/debian/Release_Specific_Release_Notes
46
devices/AM62LX/debian/Getting_Started_Guide
57
debian/Building_Debian_Image
68
debian/Building_Debian_Packages

configs/AM62PX/AM62PX_debian_config.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Replacement Variables
1616
'__PART_FAMILY_NAME__' : 'AM62Px'
1717
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62Px'
1818
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
19-
'__SDK_BUILD_MACHINE__' : 'am62xx-evm'
19+
'__SDK_BUILD_MACHINE__' : 'am62pxx-evm'
2020
'__SDK_FULL_NAME__' : 'Debian for AM62Px'
2121
'__SDK_SHORT_NAME__' : 'Debian'
2222
'__SDK_DOWNLOAD_URL__' : '`AM62Px-SDK-Download-page <https://www.ti.com/tool/PROCESSOR-SDK-AM62P>`__'

configs/AM62PX/AM62PX_debian_toc.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
devices/AM62PX/debian/index
22

33
debian/Overview
4+
devices/AM62PX/debian/Release_Specific
5+
devices/AM62PX/debian/Release_Specific_Release_Notes
46
devices/AM62PX/debian/Getting_Started_Guide
57
debian/Building_Debian_Image
68
debian/Building_Debian_Packages

source/debian/Building_Debian_Image.rst

Lines changed: 55 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Introduction
66
============
77

88
Texas Instruments uses the **Armbian** build framework to generate Debian images for its platforms.
9-
*Armbian* describes itself to be a "base operating system"; that is, a build framework used to build
9+
Armbian describes itself to be a "base operating system"; that is, a build framework used to build
1010
Linux images optimized for Single-Board Computers.
1111

1212
|__SDK_DOWNLOAD_URL__| provides Debian images, but users can also build these, especially if users
@@ -22,8 +22,9 @@ time, see `Armbian Documentation <https://docs.armbian.com/>`__.
2222
Get Armbian
2323
-----------
2424

25-
For the time being, TI's fork of Armbian maintains support for TI platforms. Therefore, the first
26-
step is to fetch TI's fork:
25+
For the time being, `TI's fork <https://github.com/TexasInstruments/armbian-build.git>`__ of
26+
`Armbian/build <https://github.com/armbian/build.git>`__ maintains support for TI platforms.
27+
Therefore, the first step is to fetch TI's fork:
2728

2829
.. code-block:: console
2930
@@ -32,75 +33,81 @@ step is to fetch TI's fork:
3233
Repository Structure
3334
--------------------
3435

35-
There are 4 files and directories of relevance to this high-level overview:
36+
The below files and directories are relevant to this high-level overview:
3637

37-
- :file:`configs/`: This directory has configurations for boards, families, kernel configurations,
38-
desktop or CLI environments and so on. To find configuration files relevant to TI, see:
38+
- :file:`config/`: This directory has configurations for boards, families, kernel configurations,
39+
desktop or CLI environments and so on. To find configuration files relevant to TI, see:
3940

40-
- :file:`configs/sources/families/k3.conf`
41-
- :file:`configs/kernel/linux-k3-current.conf`
42-
- :file:`configs/kernel/linux-k3-rt-current.conf`
41+
- :file:`config/boards/<TI EVM board>.conf`
42+
- :file:`config/sources/families/k3.conf`
43+
- :file:`config/kernel/linux-k3-current.conf`
44+
- :file:`config/kernel/linux-k3-rt-current.conf`
4345

44-
- :file:`compile.sh`: This is the script that the user should run for building Armbian images.
46+
- :file:`compile.sh`: This is the script that the user should run for building Armbian images.
4547

46-
- :file:`lib/`: This directory stores the scripts that do most of the work in building Armbian images.
48+
- :file:`lib/`: This directory stores the scripts that do most of the work in building Armbian images.
4749

48-
- :file:`extensions/`: This directory has files that define **extension hooks**. In Armbian, *extension
49-
hooks* are function signatures, which the build framework calls in the process of building an
50-
image. However, the build framework does not define these in ``lib/``. Users can define these
51-
functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh``
52-
extension file. To customize the build process, create a new file in this directory, and define
53-
your extension hooks there. Once the file is created, be sure to add the following line to
54-
board/family config file:
50+
- :file:`extensions/`: This directory has files that define **extension hooks**. In Armbian, extension
51+
hooks are function signatures, which the build framework calls in the process of building an
52+
image. However, the build framework does not define these in ``lib/``. Users can define these
53+
functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh``
54+
extension file. To customize the build process, create a new file in this directory, and define
55+
your extension hooks there. Once the file is created, be sure to add the following line to
56+
board/family config file:
5557

5658
.. code-block:: console
5759
5860
enable_extension <extension_name>
5961
60-
- :file:`userpatches/`: This directory stores files that define build parameters, user patches and so on.
62+
- :file:`userpatches/`: This directory stores files that define build parameters, user patches and so on.
6163

6264
Building Images
6365
---------------
6466

65-
Armbian supports an interactive build process. To build interactively, go to TI's Armbian fork you
66-
cloned, and use the following command:
67+
Armbian supports both an interactive UI and a non-interactive build process.
6768

68-
.. code-block:: console
69+
- To build interactively:
6970

70-
./compile.sh
71+
.. code-block:: console
7172
72-
The build framework will then display dialog boxes. The user can use this to select the board, CLI
73-
or desktop environment, kernel configurations and so on.
73+
./compile.sh
7474
75-
To build the image non-interactively, specify all required **Build Switches** in the command:
75+
The build framework will then display dialog boxes. The user can use this to select the board, CLI
76+
or desktop environment, kernel configurations and so on.
7677

77-
.. code-block:: console
78+
- To build non-interactively:
7879

79-
./compile.sh [command] [switch...] [command...]
80+
.. code-block:: console
8081
81-
A full list of build switches is available at `Build Switches <https://docs.armbian.com/Developer-Guide_Build-Switches/>`__.
82+
./compile.sh [command] [switch...] [command...]
8283
83-
For example, the following command builds the minimal non-RT Trixie image:
84+
A full list of build switches is available at `Build Switches <https://docs.armbian.com/Developer-Guide_Build-Switches/>`__.
8485

85-
.. code-block:: console
86+
.. warning::
87+
88+
If build issues arise, try adding these build switches to the end of the build command:
89+
90+
.. code-block:: console
91+
92+
GIT_SKIP_SUBMODULES=yes SKIP_ARMBIAN_REPO=yes
93+
94+
For example, the following command builds the minimal non-RT Trixie image:
95+
96+
.. code-block:: console
97+
98+
./compile.sh build BOARD=<board> BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie GIT_SKIP_SUBMODULES=yes SKIP_ARMBIAN_REPO=yes
99+
100+
For a list of boards corresponding to each SoC, refer:
101+
102+
.. csv-table::
103+
:header: "SoC", "Board", "Board Config File"
86104

87-
./compile.sh build BOARD=<target> BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie SKIP_ARMBIAN_REPO=yes
88-
89-
For a list of targets corresponding to each board, refer:
90-
91-
+------------------------------+--------------+
92-
| Board | Target |
93-
+==============================+==============+
94-
| AM62P | sk-am62p |
95-
+------------------------------+--------------+
96-
| AM62x | sk-am62b |
97-
+------------------------------+--------------+
98-
| AM62-LP | sk-am62-lp |
99-
+------------------------------+--------------+
100-
| AM62SIP | sk-am62-sip |
101-
+------------------------------+--------------+
102-
| AM64x | sk-am64b |
103-
+------------------------------+--------------+
105+
AM62Lx,am62lxx-evm,``config/boards/am62lxx-evm.conf``
106+
AM62Px,am62pxx-evm,``config/boards/am62pxx-evm.conf``
107+
AM62x,sk-am62b,``config/boards/sk-am62b.conf``
108+
AM62-LP,sk-am62-lp,``config/boards/sk-am62-lp.conf``
109+
AM62SIP,sk-am62-sip,``config/boards/sk-am62-sip.conf``
110+
AM64x,sk-am64b,``config/boards/sk-am64b.conf``
104111

105112

106113
``output/images/`` stores the built images. These images have a ``.img`` extension.

source/debian/Building_Debian_Packages.rst

Lines changed: 40 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,92 +2,94 @@
22
Building Debian Packages
33
========================
44

5-
`Debian-Repos <https://github.com/TexasInstruments/debian-repos>`__ is a set of scripts to build TI's Debian packages with a single command.
5+
`debian-repos <https://github.com/TexasInstruments/debian-repos>`__ is a set of scripts to build TI's Debian packages with a single command.
66

77
The generation of a Debian package from a binary or source involves many steps such as, obtaining the source code in tar (compressed) format, generating template files, modifying template file. The host build system and host build environment variables should also be configured.
88

9-
The `run.sh` script handles these steps, thus the building of a deb package for TI's packages is as simple as running `run.sh` with the desired package's name.
9+
The :file:`run.sh` script handles these steps, thus the building of a deb package for TI's packages is as simple as running :file:`run.sh` with the desired package's name.
1010

1111
This repository is useful to the following audience:
1212

13-
1. Potential package contributors who want to fix bugs or add enhancements to TI packages.
14-
2. Users who want to create a new package with the latest changes or customizations.
15-
3. Anyone who wants to study Debian packaging.
13+
- Potential package contributors who want to fix bugs or add enhancements to TI packages.
14+
- Users who want to create a new package with the latest changes or customizations.
15+
- Anyone who wants to study Debian packaging.
1616

1717
Structure
1818
=========
1919

20-
The `run.sh` file is the "main" script that should be run. It takes as argument the name of the package to be built.
20+
The :file:`run.sh` file is the "main" script that should be run. It takes as argument the name of the package to be built.
2121

22-
Each TI package has a corresponding directory, named after its source package. Within this directory exists the `suite/<distro-variant>/debian/` path. All Debian related files (`control`, `rules`, man pages etc) for the package are located here.
22+
Each TI package has a corresponding directory, named after its source package. Within this directory exists the :file:`suite/<distro-variant>/debian/` path. All Debian related files (:file:`control`, :file:`rules`, man pages etc) for the package are located here.
2323

24-
There also exists a `<package-name>/version.sh` file. This file is sourced by `run.sh`.
24+
There also exists a :file:`<package-name>/version.sh` file. This file is sourced by :file:`run.sh`.
2525

2626
Setting Up Host for the build
2727
=============================
2828

29-
The `debian-repos` only support native compilation of packages. Hence, the build has to be done either on the ARM64 Target or ARM64 Docker Container or ARM64 Chroot Environment.
29+
`debian-repos <https://github.com/TexasInstruments/debian-repos>`__ only supports native compilation of packages. Hence, the build has to be done either on the ARM64 target or an ARM64 Docker Container.
3030

3131
When running on native ARM64 target, no additional setup is required. Proceed with Building the Package.
3232

33-
To setup and run an ARM64 Docker, run the following commands:
33+
To setup and run an ARM64 Docker Container, run the following commands:
3434

3535
.. code-block::
3636
37-
# Setup Qemu multiarch support
38-
sudo apt-get install qemu binfmt-support qemu-user-static
39-
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
37+
# Setup Qemu multiarch support
38+
sudo apt install qemu binfmt-support qemu-user-static
39+
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
4040
41-
# Run ARM64 Container
42-
docker pull ghcr.io/texasinstruments/debian-arm64:latest
43-
docker run --rm -it ghcr.io/texasinstruments/debian-arm64:latest
41+
# Run ARM64 Container
42+
docker pull ghcr.io/texasinstruments/debian-arm64:latest
43+
docker run --rm -it ghcr.io/texasinstruments/debian-arm64:latest bash
4444
4545
Building the Package
4646
====================
4747

48-
Clone `debian-repos <https://github.com/TexasInstruments/debian-repos>`__
48+
#. Clone `debian-repos <https://github.com/TexasInstruments/debian-repos>`__:
4949

50-
.. code-block::
50+
.. code-block::
5151
52-
git clone https://github.com/TexasInstruments/debian-repos.git
53-
cd debian-repos
52+
git clone https://github.com/TexasInstruments/debian-repos.git
53+
cd debian-repos
5454
55-
To build a package, the syntax is:
55+
#. Build package:
5656

57-
.. code-block::
57+
.. code-block::
5858
59-
./run.sh <package-name>
59+
./run.sh <package-name>
6060
61-
This command carries out all the necessary steps to build the package including installation of package-specific dependencies. The package and all related files are then stored in `build/<package-name>`.
61+
.. note::
6262

63-
For example: to build `ti-linux-kernel`, the command is:
63+
This command carries out all the necessary steps to build the package including installation of package-specific dependencies.
64+
The package and all related files are then stored in :file:`build/<package-name>`.
6465

65-
.. code-block::
66+
For example: to build :file:`ti-linux-kernel`, the command is:
67+
68+
.. code-block::
6669
67-
./run.sh ti-linux-kernel
70+
./run.sh ti-linux-kernel
6871
69-
The output is then found in `build/ti-linux-kernel/`.
72+
The output is then found in :file:`build/ti-linux-kernel/`.
7073

7174
Adding Packages
7275
===============
7376

7477
To add a package, follow the following steps:
7578

76-
1. Create nested directories as follows:
79+
#. Create directory structure:
7780

78-
.. code-block::
79-
80-
mkdir -p <proj-name>/suite/<distro-variant>/debian/
81+
.. code-block::
8182
82-
2. Copy all ``debian/`` specific files that are relevant to building the package:
83+
mkdir -p <proj-name>/suite/<distro-variant>/debian/
8384
84-
.. code-block::
85+
#. Copy all :file:`debian/` specific files that are relevant to building the package:
8586

86-
cp /path/to/debian/* -r <proj-name>/suite/<distro-variant>/debian/
87+
.. code-block::
8788
88-
3. In ``<proj-name>/``, create the ``version.sh`` file. The file must export the following variables:
89+
cp /path/to/debian/* -r <proj-name>/suite/<distro-variant>/debian/
8990
90-
.. code-block::
91+
#. In :file:`<proj-name>/`, create the :file:`version.sh` file. The file must export the following variables:
9192

92-
git_repo # link from which to clone
93+
.. code-block::
9394
95+
git_repo # link from which to clone

0 commit comments

Comments
 (0)