docs(debian): Mass update debian guides following 11.01.16.13 release

First passthrough updating debian docs, more to come in future.
Fixed formatting and updated some content.
Updates following Oct 2025 11.01 release.

Signed-off-by: Jonas Wood <[email protected]>

Author: jonaswood01

source/debian/Building_Debian_Image.rst

@@ -6,7 +6,7 @@ Introduction
 ============
 
 Texas Instruments uses the **Armbian** build framework to generate Debian images for its platforms.
-*Armbian* describes itself to be a "base operating system"; that is, a build framework used to build
+Armbian describes itself to be a "base operating system"; that is, a build framework used to build
 Linux images optimized for Single-Board Computers.
 
 |__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/>`__.
 Get Armbian
 -----------
 
-For the time being, TI's fork of Armbian maintains support for TI platforms. Therefore, the first
-step is to fetch TI's fork:
+For the time being, `TI's fork <https://github.com/TexasInstruments/armbian-build.git>`__ of
+`Armbian/build <https://github.com/armbian/build.git>`__ maintains support for TI platforms.
+Therefore, the first step is to fetch TI's fork:
 
 .. code-block:: console
 
@@ -32,75 +33,91 @@ step is to fetch TI's fork:
 Repository Structure
 --------------------
 
-There are 4 files and directories of relevance to this high-level overview:
+The following files and directories are relevant to this high-level overview:
 
-- :file:`configs/`: This directory has configurations for boards, families, kernel configurations,
-  desktop or CLI environments and so on. To find configuration files relevant to TI, see:
+-  :file:`config/`: This directory has configurations for boards, families, kernel configurations,
+   desktop or CLI environments and so on. To find configuration files relevant to TI, see:
 
-   - :file:`configs/sources/families/k3.conf`
-   - :file:`configs/kernel/linux-k3-current.conf`
-   - :file:`configs/kernel/linux-k3-rt-current.conf`
+   - :file:`config/boards/<TI EVM board>.conf`
+   - :file:`config/sources/families/k3.conf`
+   - :file:`config/kernel/linux-k3-current.conf`
+   - :file:`config/kernel/linux-k3-rt-current.conf`
 
-- :file:`compile.sh`: This is the script that the user should run for building Armbian images.
+-  :file:`compile.sh`: This is the script that the user should run for building Armbian images.
 
-- :file:`lib/`: This directory stores the scripts that do most of the work in building Armbian images.
+-  :file:`lib/`: This directory stores the scripts that do most of the work in building Armbian images.
 
-- :file:`extensions/`: This directory has files that define **extension hooks**. In Armbian, *extension
-  hooks* are function signatures, which the build framework calls in the process of building an
-  image. However, the build framework does not define these in ``lib/``. Users can define these
-  functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh``
-  extension file. To customize the build process, create a new file in this directory, and define
-  your extension hooks there. Once the file is created, be sure to add the following line to
-  board/family config file:
+-  :file:`extensions/`: This directory has files that define **extension hooks**. In Armbian, extension
+   hooks are function signatures, which the build framework calls in the process of building an
+   image. However, the build framework does not define these in ``lib/``. Users can define these
+   functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh``
+   extension file. To customize the build process, create a new file in this directory, and define
+   your extension hooks there. Once the file is created, be sure to add the following line to
+   board/family config file:
 
    .. code-block:: console
 
       enable_extension <extension_name>
 
-- :file:`userpatches/`: This directory stores files that define build parameters, user patches and so on.
+-  :file:`userpatches/`: This directory stores files that define build parameters, user patches and so on.
 
 Building Images
 ---------------
 
-Armbian supports an interactive build process. To build interactively, go to TI's Armbian fork you
-cloned, and use the following command:
+Armbian supports both an interactive UI and a noninteractive build process.
 
-.. code-block:: console
+.. note::
 
-   ./compile.sh
+   This build guide has been tested on an x86 host machine running Ubuntu 22.04. The Armbian :file:`compile.sh` script
+   builds in an ARM64 docker container. Ensure the following packages are installed:
 
-The build framework will then display dialog boxes. The user can use this to select the board, CLI
-or desktop environment, kernel configurations and so on.
+   .. code-block:: console
 
-To build the image non-interactively, specify all required **Build Switches** in the command:
+      sudo apt update
+      sudo apt install docker.io qemu qemu-user-static binfmt-support
 
-.. code-block:: console
+-  To build interactively:
 
-   ./compile.sh [command] [switch...] [command...]
+   .. code-block:: console
 
-A full list of build switches is available at `Build Switches <https://docs.armbian.com/Developer-Guide_Build-Switches/>`__.
+      ./compile.sh
 
-For example, the following command builds the minimal non-RT Trixie image:
+   The build framework will then display dialog boxes. The user can use this to select the board, CLI
+   or desktop environment, kernel configurations and so on.
 
-.. code-block:: console
+-  To build non-interactively:
+
+   .. code-block:: console
+
+      ./compile.sh [command] [switch...] [command...]
+
+   A full list of build switches is available at `Build Switches <https://docs.armbian.com/Developer-Guide_Build-Switches/>`__.
+
+   .. warning::
+
+      If build issues arise, try adding these build switches to the end of the build command:
+
+      .. code-block:: console
+
+         GIT_SKIP_SUBMODULES=yes SKIP_ARMBIAN_REPO=yes
+
+   For example, the following command builds the minimal non-RT Trixie image:
+
+   .. code-block:: console
+
+      ./compile.sh build BOARD=<board> BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie GIT_SKIP_SUBMODULES=yes SKIP_ARMBIAN_REPO=yes
+
+For a list of boards and branches supported by each SoC, refer:
+
+   .. csv-table::
+      :header: "SoC", "Board", "Board Config File", "Branch"
 
-   ./compile.sh build BOARD=<target> BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie SKIP_ARMBIAN_REPO=yes
-
-For a list of targets corresponding to each board, refer:
-
-      +------------------------------+--------------+
-      | Board                        | Target       |
-      +==============================+==============+
-      | AM62P                        | sk-am62p     |
-      +------------------------------+--------------+
-      | AM62x                        | sk-am62b     |
-      +------------------------------+--------------+
-      | AM62-LP                      | sk-am62-lp   |
-      +------------------------------+--------------+
-      | AM62SIP                      | sk-am62-sip  |
-      +------------------------------+--------------+
-      | AM64x                        | sk-am64b     |
-      +------------------------------+--------------+
+      AM62Lx,am62lxx-evm,``config/boards/am62lxx-evm.conf``,"current, current-rt, edge"
+      AM62Px,am62pxx-evm,``config/boards/am62pxx-evm.conf``,"current, current-rt, edge"
+      AM62x,sk-am62b,``config/boards/sk-am62b.conf``,"current, edge"
+      AM62-LP,sk-am62-lp,``config/boards/sk-am62-lp.conf``,"current, current-rt, edge"
+      AM62SIP,sk-am62-sip,``config/boards/sk-am62-sip.conf``,"current, current-rt, edge"
+      AM64x,sk-am64b,``config/boards/sk-am64b.conf``,"current, edge"
 
 
 ``output/images/`` stores the built images. These images have a ``.img`` extension.

source/debian/Building_Debian_Packages.rst

@@ -2,92 +2,94 @@
 Building Debian Packages
 ========================
 
-`Debian-Repos <https://github.com/TexasInstruments/debian-repos>`__ is a set of scripts to build TI's Debian packages with a single command.
+`debian-repos <https://github.com/TexasInstruments/debian-repos>`__ is a set of scripts to build TI's Debian packages with a single command.
 
 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.
 
-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.
+The :file:`run.sh` script handles these steps. Therefore, the building of a deb package for TI's packages is as simple as running :file:`run.sh` with the package's name as a command line argument.
 
 This repository is useful to the following audience:
 
-1. Potential package contributors who want to fix bugs or add enhancements to TI packages.
-2. Users who want to create a new package with the latest changes or customizations.
-3. Anyone who wants to study Debian packaging.
+-  Potential package contributors who want to fix bugs or add enhancements to TI packages.
+-  Users who want to create a new package with the latest changes or customizations.
+-  Anyone who wants to study Debian packaging.
 
 Structure
 =========
 
-The `run.sh` file is the "main" script that should be run. It takes as argument the name of the package to be built.
+The :file:`run.sh` file is the "main" script. It takes as argument the name of the package to build.
 
-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.
+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.
 
-There also exists a `<package-name>/version.sh` file. This file is sourced by `run.sh`.
+There also exists a :file:`<package-name>/version.sh` file. This file is sourced by :file:`run.sh`.
 
 Setting Up Host for the build
 =============================
 
-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.
+`debian-repos <https://github.com/TexasInstruments/debian-repos>`__ only supports native compilation of packages. Therefore, the build has to be done either on the ARM64 target or an ARM64 Docker Container.
 
 When running on native ARM64 target, no additional setup is required. Proceed with Building the Package.
 
-To setup and run an ARM64 Docker, run the following commands:
+To setup and run an ARM64 Docker Container, run the following commands:
 
 .. code-block::
 
-    # Setup Qemu multiarch support
-    sudo apt-get install qemu binfmt-support qemu-user-static
-    docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+   # Setup Qemu multiarch support
+   sudo apt install qemu binfmt-support qemu-user-static
+   docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
 
-    # Run ARM64 Container
-    docker pull ghcr.io/texasinstruments/debian-arm64:latest
-    docker run --rm -it ghcr.io/texasinstruments/debian-arm64:latest
+   # Run ARM64 Container
+   docker pull ghcr.io/texasinstruments/debian-arm64:latest
+   docker run --rm -it ghcr.io/texasinstruments/debian-arm64:latest bash
 
 Building the Package
 ====================
 
-Clone `debian-repos <https://github.com/TexasInstruments/debian-repos>`__
+#. Clone `debian-repos <https://github.com/TexasInstruments/debian-repos>`__:
 
-.. code-block::
+   .. code-block::
 
-   git clone https://github.com/TexasInstruments/debian-repos.git
-   cd debian-repos
+      git clone https://github.com/TexasInstruments/debian-repos.git
+      cd debian-repos
 
-To build a package, the syntax is:
+#. Build package:
 
-.. code-block::
+   .. code-block::
 
-    ./run.sh <package-name>
+      ./run.sh <package-name>
 
-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>`.
+   .. note::
 
-For example: to build `ti-linux-kernel`, the command is:
+      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 :file:`build/<package-name>`.
 
-.. code-block::
+   For example: to build :file:`ti-linux-kernel`, the command is:
+
+   .. code-block::
 
-    ./run.sh ti-linux-kernel
+      ./run.sh ti-linux-kernel
 
-The output is then found in `build/ti-linux-kernel/`.
+   The output is then found in :file:`build/ti-linux-kernel/`.
 
 Adding Packages
 ===============
 
 To add a package, follow the following steps:
 
-1. Create nested directories as follows:
+#. Create directory structure:
 
-.. code-block::
-
-    mkdir -p <proj-name>/suite/<distro-variant>/debian/
+   .. code-block::
 
-2. Copy all ``debian/`` specific files that are relevant to building the package:
+      mkdir -p <proj-name>/suite/<distro-variant>/debian/
 
-.. code-block::
+#. Copy all :file:`debian/` specific files that are relevant to building the package:
 
-    cp /path/to/debian/* -r  <proj-name>/suite/<distro-variant>/debian/
+   .. code-block::
 
-3. In ``<proj-name>/``, create the ``version.sh`` file. The file must export the following variables:
+      cp /path/to/debian/* -r  <proj-name>/suite/<distro-variant>/debian/
 
-.. code-block::
+#. In :file:`<proj-name>/`, create the :file:`version.sh` file. The file must export the following variables:
 
-    git_repo # link from which to clone
+   .. code-block::
 
+      git_repo # link from which to clone

source/debian/Overview.rst

@@ -11,19 +11,18 @@ TI creates Debian images by using the popular project called **Armbian**. Armbia
 Single-Board Computers. Unlike other tools, such as mmdebstrap and bdebstrap, which are often
 used for creating Debian images, Armbian focuses on creating images for Single-Board Computers.
 
-TI's AM62LX, AM62Px, AM62x and AM64x platforms offer the Debian distribution. Few key highlights of
-this project are:
+A few key highlights of this project are:
 
-- The Debian filesystem image requires standard packages from debian.org and TI's customizations as
-  ``.deb`` packages. TI's package build infrastructure uses public sources of git repositories to build
-  deb packages. TI's official repository maintained on `Github/TexasInstruments/ti-debpkgs
-  <https://github.com/TexasInstruments/ti-debpkgs>`__ hosts these packages.
+-  The Debian filesystem image requires standard packages from debian.org and TI's additional packages as
+   ``.deb`` packages. TI's package build infrastructure uses public sources of git repositories to build
+   deb packages. TI's official repository maintained on `Github/TexasInstruments/ti-debpkgs
+   <https://github.com/TexasInstruments/ti-debpkgs>`__ hosts these packages.
 
-- This document also provides the required steps and instructions to customize the TI's components
-  for AM62Lx, AM62Px, AM62x and AM64x Systems-on-Chip and create the corresponding deb packages.
+-  This document also provides the required steps and instructions to customize the TI's components
+   for |__PART_FAMILY_DEVICE_NAMES__| System-on-a-Chip (SoC) and create the corresponding deb packages.
 
-- The entire project is public and we accept community contributions as pull requests to GitHub
-  repositories.
+-  The entire project is public and we accept community contributions as pull requests to GitHub
+   repositories.
 
 Debian vs Yocto
 ===============
@@ -37,8 +36,8 @@ Comparison
 +-------------------+--------------------------------------+---------------------------------------+
 |  **File System**  |              **Debian**              |    **OpenEmbedded/Yocto (Arago)**     |
 +-------------------+--------------------------------------+---------------------------------------+
-| Build Time        | Faster since all the packages are    | All the packages are built from       |
-|                   | downloaded as deb packages and       | source. so build time is too high.    |
+| Build Time        | Fast since all the packages are      | All the packages are built from       |
+|                   | downloaded as deb packages and       | source. so build time is high.        |
 |                   | installed.                           |                                       |
 +-------------------+--------------------------------------+---------------------------------------+
 | Patching SW Stack | Difficult because all components are | Since all the components are built    |
@@ -59,8 +58,9 @@ Comparison
 Acknowledgements
 ================
 
-    - `armbian/build <https://github.com/armbian/build/>`__
-    - `beagleboard/repos-arm64 <https://git.beagleboard.org/beagleboard/repos-arm64>`__
+-  `armbian/build <https://github.com/armbian/build/>`__
+-  `TI/armbian-build <https://github.com/TexasInstruments/armbian-build>`__
+-  `beagleboard/repos-arm64 <https://git.beagleboard.org/beagleboard/repos-arm64>`__
 
 
 .. _technical-support:
@@ -74,13 +74,10 @@ path for developing a product based on the Linux/Debian/RTOS/Android SDKs.
 However, we know we'll never cover everything that can be done, and
 occasionally we even make mistakes <gasp>. So, when you can't seem to
 find what you need, there's a good place to search through previously
-answered questions and ask a new one - The E2E Support Forums.
-
-There is an active community of TIers and other customers like you
-already using a TI Processor, on these forums. You may find your
-question has already been answered with a quick Search of the Forums. If
-not, a quick post will likely provide you the answers you need.
-
--  `E2E Processor Support
-   <https://e2e.ti.com/support/processors/>`__
+answered questions or ask a new one:
+the `E2E Support Forums <https://e2e.ti.com/support/processors/>`__.
 
+The E2E Support Forums is an active community of TIers and other customers
+like you already using a TI Processor. You may find your question has already
+been answered with a quick Search of the Forums. If not, a quick post will
+likely provide you the answers you need.

source/debian/_Debian_Developers_Guide.rst

@@ -3,5 +3,5 @@ Thank you for choosing to evaluate one of our `TI Processors
 of the Box experience is designed to quickly
 provide the information you need most while evaluating a TI
 microprocessor, specifically running one of the Software Architectures
-available, Embedded Linux.
+available: Embedded Linux.
 

source/linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux.rst

@@ -114,7 +114,16 @@ Connect to Wi-Fi
 
    .. code-block:: console
 
+      nmcli device wifi list
       nmcli device wifi connect "<SSID>" password "<password>"
 
+   .. note::
+
+      The following command also works and will prompt for a password:
+
+      .. code-block:: console
+
+         nmcli device wifi connect --ask "<SSID>"
+
 For more information on the Wi-Fi capabilities of the CC33xx devices, please
 see the documentation that can be found in the `CC33xx SDK <https://www.ti.com/tool/CC33XX-SOFTWARE>`_.