Welcome to the PTXdist Universe

• 1. Welcome to the Embedded World
  • 1.1. First Steps in the Embedded World
  • 1.2. From Server to Embedded
  • 1.3. Linux = Embedded Linux
• 2. Getting a working Environment
  • 2.1. Download Software Components
    • Main Parts of PTXdist
    • Extracting the Sources
    • Prerequisites
    • Configuring PTXdist
  • 2.2. Toolchains
    • Using Existing Toolchains from Different Vendors
    • Using a Pre-Built Toolchain
    • Building a Toolchain
    • Building the OSELAS.Toolchain for OSELAS.BSP-Pengutronix-Example
    • Protecting the Toolchain
    • Installing the Toolchain
    • Building additional Toolchains
• 3. PTXdist User’s Manual
  • 3.1. How does it work?
    • PTXdist’s perception of the world
    • PTXdist’s build process
  • 3.2. First steps with PTXdist
    • Extracting the Board Support Package
    • Selecting a Userland Configuration
    • Selecting a Hardware Platform
    • Selecting a Toolchain
    • Building the Root Filesystem Content
    • What we Got Now
    • Creating a Root Filesystem Image
  • 3.3. Adapting the OSELAS.BSP-Pengutronix-Example Project
    • Working with Kconfig
    • Adapting Userland Settings
    • Adapting Platform Settings
    • Adapting Linux Kernel Settings
    • Adapting Bootloader Settings
    • Making Changes Real
• 4. PTXdist Developer’s Manual
  • 4.1. PTXdist’s Directory Hierarchy
    • Rule Files
    • Patch Series
    • Runtime Configuration
  • 4.2. Adding New Packages
    • Rule File Creation
    • Make it Work
  • 4.3. Advanced Rule Files
    • Adding Static Configure Parameters
    • Adding Dynamic Configure Parameters
    • Managing External Compile Time Dependencies
    • Managing External Compile Time Dependencies on Demand
    • Managing External Runtime Dependencies
    • Managing Plain Makefile Packages
    • Managing CMake/QMake/Meson Packages
    • Managing Python Packages
    • Managing Cargo Packages
  • 4.4. Patching Packages
    • Creating a Patch Series for a Package
    • Adding More Patches to a Package
    • Modifying Autotoolized Packages
  • 4.5. Adding Binary Only Files
    • Add Binary Files File by File
    • Add Binary Files via an Archive
    • Creating a Rules File
  • 4.6. Creating New Package Templates
    • Modifying a Template
    • Creating a New Template
  • 4.7. Tracking licensing information in packages
    • Finding licensing information
    • Distillation into license identifiers
    • Adding license files to PTXdist packages
  • 4.8. Layers in PTXdist
    • Writing Layer Aware Rules
    • PTXdist Config Files with Multiple Layers
    • Packages with kconfig Based Config Files
  • 4.9. Kconfig Diffs
    • Using Kconfig diffs
    • Kconfig diffs and layers
  • 4.10. Code Signing
    • Code Signing Providers
    • Managing Certificate Authority Keyrings
    • Code Signing Consumers
• 5. PTXdist Reference
  • 5.1. Variables Reference
    • Global Variables
    • Package Specific Variables
  • 5.2. Rule File Macro Reference
    • targetinfo
    • touch
    • clean
    • world/get, world/extract, world/prepare, world/compile, world/install
    • extract
    • compile
    • world/execute, execute
    • ptx/image-install, ptx/image-install-link, world/image-clean
    • world/image-fit
    • install_copy
    • install_tree
    • install_alternative_tree
    • install_alternative
    • install_link
    • install_archive
    • install_glob
    • install_lib
    • install_replace
    • ptx/cfghash, ptx/cfghash-file
    • ptx/endis, ptx/disen, ptx/wow, ptx/wwo, ptx/yesno, ptx/truefalse, ptx/falsetrue, ptx/onoff, ptx/ifdef
    • ptx/get-alternative
    • ptx/in-path
    • ptx/in-platformconfigdir
  • 5.3. Rule File Layout
    • Default stage rules
    • Skipping a Stage
  • 5.4. PTXdist parameter reference
    • Setup and Project Actions
    • Build Actions
    • Clean Actions
    • Misc Actions
    • Overwrite defaults
    • Options
  • 5.5. Code Signing Helper Functions
    • SoftHSM Provider Functions
    • Generic Provider Functions
    • Consumer Functions
• 6. Various Aspects of Daily Work
  • 6.1. Using an External Kernel Source Tree
    • Cloning the Linux Kernel Source Tree
    • Configuring the PTXdist Project
    • Work Flow
  • 6.2. Using the Code Signing Infrastructure with the Kernel Recipe
    • Trusted Root CAs
    • Kernel Module Signing
  • 6.3. Discovering Runtime Dependencies
    • Dependencies on Shared Libraries
    • Dependencies on other Resources
  • 6.4. Debugging with CPU emulation
    • Running an Application made for a different Architecture
    • Debugging an Application made for a different Architecture
  • 6.5. Migration between Releases
  • 6.6. Increasing Build Speed
    • Using available CPU Cores
    • Manually adjusting CPU Core usage
    • Building in Background
    • Building Platforms in Parallel
  • 6.7. Using a Distributed Compiler
    • Setting-Up the Distributed Compiler
    • Enabling PTXdist for the Distributed Compiler
    • How to use the Distributed Compiler with PTXdist
  • 6.8. Using Pre-Built Archives
    • Introduction
    • Creating Pre-Built Archives
    • Using Pre-Built Archives
    • Packages without Pre-Built Archives Support
    • Workflow with Pre-Built Archives
    • Use Cases
  • 6.9. Downloading Packages from the Web
  • 6.10. Creating Autotools based Packages
    • Shared components
    • Creating a Library Template
    • Creating an Executable Template
    • Creating an Executable with a Library Template
  • 6.11. Controlling Package Dependencies in more Detail
    • Implicit Dependencies
    • Build-Time only Dependency
    • Run-Time only Dependency
  • 6.12. umask Pitfall
  • 6.13. Read Only Filesystem
    • Partially RAM Disks
    • Overlay RAM Disk
  • 6.14. Using a userland NFS Server for the Target
    • Using PTXdist’s built-in NFS Userland Server
    • File Permissions and Ownership
  • 6.15. Supporting Multiple Device Variants in one Platform
    • Providing a Bootloader for each Variant
    • Creating Individual Root-Filesystems for each Variant
    • Putting it all Together
  • 6.16. The PTXdist User Manual
    • Requirements to build the Documentation
    • Building the Documentation
  • 6.17. Integrate project specific Documentation into the Manual
    • Documentation structure for layered BSPs
• 7. Contributing to PTXdist
  • 7.1. Development Tree
  • 7.2. How to Contribute
  • 7.3. PTXdist Packages
    • Package Builds should be Reproducible
    • Packages Suboptions
    • Updating a Package to a new Version
    • Misc
  • 7.4. Helper Scripts
    • configure_helper.py
• 8. Frequently Asked Questions (FAQ)
  • 8.1. PTXdist does not support to generate some files in a way I need them. What can I do?
  • 8.2. How can I stop PTXdist to build in parallel?
  • 8.3. I get errors like “unterminated call to function ‘call’: missing ‘)’”
  • 8.4. I got a message similar to “package <name> is empty. not generating.” What does it mean?
  • 8.5. How do I download all required packages at once?
  • 8.6. I want to backup all source archives for my BSP
  • 8.7. OSELAS toolchain fails to start due to missing libraries
  • 8.8. PTXdist does not find my own sources: “Unknown format, cannot extract”
  • 8.9. Using more than one kernel version per BSP
  • 8.10. Using Java packages
  • 8.11. I get the error “cannot run ‘/etc/init.d/rcS’: No such file or directory”
  • 8.12. I get the error “ptxdist: archives: command not found”
  • 8.13. I have adapted my own rule file’s targetinstall stage, but PTXdist does not install the files
• 9. Getting help
  • 9.1. PTXdist Mailing List
  • 9.2. About Working on the Linux Kernel
  • 9.3. Chat: IRC and Matrix
  • 9.4. Commercial Support