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 “in a nutshell”
  • 1.2. Documentation Overview
• 2. Getting Started
  • 2.1. Preparing the System to Build KDE
    • 2.1.1. Setup a new user account
    • 2.1.2. Ensure your system is ready to build KDE software
    • 2.1.3. Setup kde-builder
      • 2.1.3.1. Install kde-builder
      • 2.1.3.2. Prepare the configuration file
        • 2.1.3.2.1. Manual setup of configuration file
  • 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. Setting the Configuration Data
  • 2.4. Using the kde-builder script
    • 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. Building specific modules
  • 2.6. Setting the Environment to Run Your KDE Plasma Desktop
    • 2.6.1. Automatically installing a login driver
      • 2.6.1.1. Adding xsession support for distributions
      • 2.6.1.2. Manually adding support for xsession
    • 2.6.2. Setting up the environment manually
  • 2.7. Module Organization and selection
    • 2.7.1. KDE Software Organization
    • 2.7.2. Selecting modules to build
    • 2.7.3. Module Sets
      • 2.7.3.1. The basic module set concept
      • 2.7.3.2. Special Support for KDE module sets
    • 2.7.4. The official KDE module database
    • 2.7.5. Filtering out KDE project modules
  • 2.8. Getting Started Conclusion
• 3. Script Features
  • 3.1. Feature Overview
  • 3.2. kde-builder's build logging
    • 3.2.1. Logging overview
      • 3.2.1.1. Logging directory layout
• 4. Configuring kde-builder
  • 4.1. Overview of kde-builder configuration
    • 4.1.1. Layout of the configuration file
      • 4.1.1.1. Global configuration
      • 4.1.1.2. Module configuration
      • 4.1.1.3. Processing of option values
      • 4.1.1.4. “options” modules
    • 4.1.2. Including other configuration files
    • 4.1.3. Commonly used configuration options
  • 4.2. Table of available configuration options
    • 4.2.1. Global scope only options
    • 4.2.2. All scopes (module, module-set and global) options
    • 4.2.3. Phase selection options
    • 4.2.4. Modules selection options
• 5. Command Line Options and Environment Variables
  • 5.1. Command Line Usage
    • 5.1.1. Specifying modules to build
    • 5.1.2. Commonly used command line options
    • 5.1.3. Exit status
    • 5.1.4. Signals
  • 5.2. Supported Environment Variables
  • 5.3. Supported command-line parameters
    • 5.3.1. Generic
    • 5.3.2. Resuming and stopping
    • 5.3.3. Modules information
    • 5.3.4. Exclude specific action
    • 5.3.5. Only specific action
    • 5.3.6. Build behavior
    • 5.3.7. Script runtime
    • 5.3.8. Setup
    • 5.3.9. Script information
• 6. Using kde-builder
  • 6.1. Preface
  • 6.2. Basic kde-builder features
    • 6.2.1. qt support
    • 6.2.2. Standard flags added by kde-builder
    • 6.2.3. Changing kde-builder's build priority
    • 6.2.4. Installation as the superuser
    • 6.2.5. Showing the progress of a module build
  • 6.3. Advanced features
    • 6.3.1. Partially building a module
      • 6.3.1.1. Removing directories from a build
    • 6.3.2. Branching and tagging support for kde-builder
      • 6.3.2.1. What are branches and tags?
      • 6.3.2.2. How to use branches and tags
    • 6.3.3. Stopping the build early
      • 6.3.3.1. The build normally continues even if failures occur
      • 6.3.3.2. Not stopping early with --no-stop-on-failure
      • 6.3.3.3. Stopping kde-builder gracefully when stop-on-failure is false
    • 6.3.4. How kde-builder tries to ensure a successful build
      • 6.3.4.1. Automatic rebuilds
      • 6.3.4.2. Manually rebuilding a module
    • 6.3.5. Changing environment variable settings
    • 6.3.6. Resuming builds
      • 6.3.6.1. Resuming a failed or canceled build
      • 6.3.6.2. Ignoring modules in a build
    • 6.3.7. Changing options from the command line
      • 6.3.7.1. Changing global options
      • 6.3.7.2. Changing module options
  • 6.4. Features for KDE developers
    • 6.4.1. SSH Agent checks
  • 6.5. Other kde-builder features
    • 6.5.1. Changing the amount of output from kde-builder
    • 6.5.2. Color output
    • 6.5.3. Removing unneeded directories after a build
  • 6.6. Tips and Tricks
    • 6.6.1. Troubleshooting
  • 6.7. Superseded profile setup procedures
    • 6.7.1. Setting up a KDE login profile
      • 6.7.1.1. Changing your startup profile settings
      • 6.7.1.2. Starting KDE
• 7. CMake, the KDE build system
  • 7.1. Introduction to CMake
• 8. Developers documentation
  • 8.1. Concepts
    • 8.1.1. Modules
    • 8.1.2. Build Phases
    • 8.1.3. Build Context
    • 8.1.4. Configuration file (rc-file)
    • 8.1.5. Command line
    • 8.1.6. Module Sets
      • 8.1.6.1. KDE module sets
    • 8.1.7. Pretend mode
    • 8.1.8. Logs and build output
  • 8.2. Basic flow
  • 8.3. KDE modules and source code organization
    • 8.3.1. The “Module”
      • 8.3.1.1. Individual modules
      • 8.3.1.2. Groups of related modules
      • 8.3.1.3. Module “branch groups”
  • 8.4. ksb::Module
    • 8.4.1. DESCRIPTION
    • 8.4.2. METHODS
      • 8.4.2.1. Perl integration
      • 8.4.2.2. CONFIGURATION
      • 8.4.2.3. INTROSPECTION
        • 8.4.2.3.1. BASIC INFORMATION
        • 8.4.2.3.2. PLUGIN HANDLERS
        • 8.4.2.3.3. PATHS
        • 8.4.2.3.4. USER AND PERSISTENT OPTIONS
        • 8.4.2.3.5. KDE-SPECIFIC HANDLERS
      • 8.4.2.4. OPERATIONS
  • 8.5. Module list construction
  • 8.6. IPC Notes
    • 8.6.1. Why IPC is necessary
    • 8.6.2. How it works, today
      • 8.6.2.1. Monitor process
      • 8.6.2.2. Ordering the update and build
      • 8.6.2.3. Squelching log messages
      • 8.6.2.4. Commands that do not require IPC
    • 8.6.3. How it will work, tomorrow
      • 8.6.3.1. The plan
        • 8.6.3.1.1. The recursive promise->wait issue
        • 8.6.3.1.2. Implication of recursive waiting problems
  • 8.7. Adding new options
  • 8.8. Project loggers
    • 8.8.1. Creating and using specific logger
    • 8.8.2. Replaced perl project-wide logger with separate loggers
• 9. Changelog and License
  • 9.1. Changelog