This is the primary documentation for BuildXL (Microsoft Build Accelerator). If you are Microsoft employee, there is some additional internal documentation on integrating BuildXL with Microsoft internal systems.

Overview

• Introduction
• Why BuildXL?
• Core Concepts
• Cross platform

Onboarding to BuildXL

• Frontends
• Frontends - DScript
• Frontends - Download
• Frontends - Javascript
• Frontends - MSBuild
• Demos
• Configuring a shared cache using an Azure Blob Storage Account
• Configuring a developer cache using an Azure Blob Storage Account

Using BuildXL

• Breakway processes
• Caching - Overview
• Caching - Build Graph
• Caching - Cache Convergence and Delayed Cache Lookup
• Caching - Two Phase Cache Lookup
• Cancellation
• Command line
• Config file
• Directory Translations
• Dirty Build
• Distributed builds
• DScript - Introduction
• DScript - Comments
• DScript - Debugging
• DScript - vs. Typescript
• DScript - Enumerations
• DScript - Evaluation Semantics
• DScript - Functions
• DScript - Globbling
• DScript - Import and Export
• DScript - List files
• DScript - Merge and Override
• DScript - Policies (Lint rules)
• DScript - Qualifiers
• DScript - Reusing Declarations (factoring)
• DScript - Templates
• DScript - Types
• File Materialization
• Filesystem modes and enumerations
• Filtering
• Incremental Scheduling
• Incremental Tools
• Interpreting and Troubleshooting ADO Error Log Messages
• Modules
• Mounts
• Paged Hashes
• Parameters (Environment Variables)
• Performance Tuning
• Pip requested file materialization
• Pip Weight
• Preserve Outputs
• Process Timeouts
• Sandboxing
• Scheduler Prioritization
• Sealed Directories
• Search Path Enumeration
• Service Pips
• Server Mode
• Source Change Affected Inputs
• Symlinks and Junctions
• File streams
• Timestamp Faking
• Unsafe Flags
• BuildXL Command line Flags

Understanding BuildXL logs

• Logging
• Cache Miss Analysis
• Console Output
• DX Error Code Details
• Execution Log (XLG)
• Execution Log Analyzer
• Execution Log Debugger
• File Access Trace File
• Options
• Primary log file
• Stats log file
• Trace file

Development guide

• Contributing
• Code of Conduct
• Developer Guide
• Development Productivity Tips and Tricks
• Installation Instructions
• Release Notes
• Security