KDE Builder Documentation

• 1. Introduction
  • 1.1. A brief introduction to kde-builder
    • 1.1.1. What is KDE Builder
    • 1.1.2. KDE Builder operation
  • 1.2. Features Overview
• 2. Getting Started
  • 2.1. Installation and initial configuration
    • 2.1.1. Initial Setup of KDE Builder
      • 2.1.1.1. Install KDE Builder
      • 2.1.1.2. Prepare the configuration file
      • 2.1.1.3. Install the dependencies for projects
  • 2.2. Alternative Installation Methods
    • 2.2.1. Using the kde-builder package available for your operating system
    • 2.2.2. Using Python packages from your operating system
    • 2.2.3. Using a Python virtual environment
  • 2.3. Editing the configuration file
  • 2.4. Using the kde-builder tool
    • 2.4.1. Loading project metadata
    • 2.4.2. Previewing what will happen when kde-builder runs
    • 2.4.3. Resolving build failures
  • 2.5. Project Organization and selection
    • 2.5.1. KDE Software Organization
    • 2.5.2. Selecting projects to build
    • 2.5.3. Groups
      • 2.5.3.1. The basic group concept
      • 2.5.3.2. Special Support for KDE groups
    • 2.5.4. The official KDE module database
    • 2.5.5. Filtering out KDE project projects
• 3. Configuring kde-builder
  • 3.1. Overview of kde-builder configuration
    • 3.1.1. Layout of the configuration file
      • 3.1.1.1. Global configuration
      • 3.1.1.2. Project configuration
      • 3.1.1.3. Processing of option values
      • 3.1.1.4. Overriding configuration
    • 3.1.2. Including other configuration files
    • 3.1.3. Commonly used configuration options
  • 3.2. List of available configuration options
    • 3.2.1. Global scope only options
    • 3.2.2. All scopes (project, group and global) options
    • 3.2.3. Phase selection options
    • 3.2.4. Projects selection options
• 4. Command Line Options and Environment Variables
  • 4.1. Command Line Usage
    • 4.1.1. Specifying projects to build
    • 4.1.2. Commonly used command line options
    • 4.1.3. Exit status
    • 4.1.4. Signals
  • 4.2. Supported Environment Variables
  • 4.3. Supported command-line parameters
    • 4.3.1. Generic
    • 4.3.2. Resuming and stopping
    • 4.3.3. Modules information
    • 4.3.4. Exclude specific action
    • 4.3.5. Only specific action
    • 4.3.6. Build behavior
    • 4.3.7. Script runtime
    • 4.3.8. Setup
    • 4.3.9. Script information
• 5. Using kde-builder
  • 5.1. Preface
  • 5.2. Basic kde-builder features
    • 5.2.1. Building Qt
    • 5.2.2. Standard flags added by kde-builder
    • 5.2.3. Changing kde-builder's build priority
    • 5.2.4. Installation as the superuser
    • 5.2.5. Showing the progress of a project build
  • 5.3. Advanced features
    • 5.3.1. Partially building a project
      • 5.3.1.1. Removing directories from a build
    • 5.3.2. Stopping the build early
      • 5.3.2.1. Decide the stopping on failures strategy
      • 5.3.2.2. Stopping kde-builder gracefully when stop-on-failure is false
    • 5.3.3. How kde-builder tries to ensure a successful build
      • 5.3.3.1. Automatic rebuilds
      • 5.3.3.2. Manually rebuilding a project
    • 5.3.4. Changing environment variable settings
    • 5.3.5. Resuming builds
      • 5.3.5.1. Resuming a failed or canceled build
      • 5.3.5.2. Ignoring projects in a build
    • 5.3.6. Changing options from the command line
      • 5.3.6.1. Changing global options
      • 5.3.6.2. Changing project options
    • 5.3.7. Installing login session
  • 5.4. Features for KDE developers
    • 5.4.1. SSH Agent checks
  • 5.5. Other kde-builder features
    • 5.5.1. Changing the amount of output from kde-builder
    • 5.5.2. Color output
    • 5.5.3. Removing unneeded directories after a build
  • 5.6. Build logging
    • 5.6.1. Logging overview
      • 5.6.1.1. Logging directory layout
  • 5.7. Tips and Tricks
    • 5.7.1. Troubleshooting
• 6. Developers documentation
  • 6.1. Concepts
    • 6.1.1. Projects
    • 6.1.2. Build Phases
    • 6.1.3. Build Context
    • 6.1.4. Configuration file (rc-file)
    • 6.1.5. Command line
    • 6.1.6. Groups
      • 6.1.6.1. KDE groups
    • 6.1.7. Pretend mode
    • 6.1.8. Logs and build output
  • 6.2. Basic flow
  • 6.3. KDE projects and source code organization
    • 6.3.1. The Project
      • 6.3.1.1. Individual projects
      • 6.3.1.2. Groups of related projects
      • 6.3.1.3. Project "branch groups"
  • 6.4. Project list construction
  • 6.5. IPC Notes
    • 6.5.1. Why IPC is necessary
    • 6.5.2. How it works, today
      • 6.5.2.1. Monitor process
      • 6.5.2.2. Ordering the update and build
      • 6.5.2.3. Squelching log messages
      • 6.5.2.4. Commands that do not require IPC
  • 6.6. Adding new options
  • 6.7. Project loggers
    • 6.7.1. Creating and using specific logger
    • 6.7.2. Replaced perl project-wide logger with separate loggers
  • 6.8. Generation of IDE project configuration
    • 6.8.1. CLion
      • 6.8.1.1. Toolchain
      • 6.8.1.2. CMake Profiles
      • 6.8.1.3. Run/Debug configuration
    • 6.8.2. VS Code
      • 6.8.2.1. Kit
      • 6.8.2.2. CMake variants
      • 6.8.2.3. Configure settings and environment
      • 6.8.2.4. Build environment
      • 6.8.2.5. Run/Debug environment
    • 6.8.3. Qt Creator
      • 6.8.3.1. Kit
        • 6.8.3.1.1. Qt version in kit
        • 6.8.3.1.2. Removing unwanted kits
      • 6.8.3.2. Configuration documentation:
        • 6.8.3.2.1. Build Configuration
        • 6.8.3.2.2. Run Configuration
      • 6.8.3.3. Environment Configuration
      • 6.8.3.4. Other notes
• 7. Miscellaneous
  • 7.1. Changelog