INDEX.md

Microsoft Build Accelerator

Guide to Documentation

This is the primary documentation for Microsoft Build Accelerator (BuildXL). If you are an internal Microsoft employee you may also want to visit the BuildXL Internal documentation where you'll find documentation about interations with systems that are not publically available.

Keep this as the sole primary landing page for documentation and avoid creating nested navigation pages for navigation.

Overview

• ReadMe
• Why BuildXL?
• Core Concepts TODO: author
• Demos

Project Documentation

• Contributing
• Code of Conduct
• Installation Instructions
• Developer Guide
• Security
• Release Notes

Product Documentation

Architecture

• Overview TODO: author
• Sandboxing TODO: groom

Setting up a build

• Command line
• Frontends TODO: groom
• Mounts
• Build Parameters (Environment Variables)
• Dirty Build
• Unsafe Flags
• Incremental Tools
• Preserve Outputs
• Process Timeouts
• Sealed Directories TODO: groom
• Search Path Enumeration

Build Execution

• Filtering
• Cache Algorithm TODO: author
• Graph Reuse
• User Profile Redirection TODO: groom
• Content and Metadata Cache TODO: groom
• Paged Hashes TODO: groom
• Filesystem modes and enumerations TODO: groom
• Incremental Scheduling TODO: groom
• Cancellation
• Resource tuning
• Pip Weight
• Scheduler Prioritization
• Server Mode
• Timestamp Faking
• Symlinks and Junctions
• Service Pips
• Pip requested file materialization
• Determinism Probe
• Source Change Affected Inputs

Logging and Analysis

• Console Output
• Log Files
• Primary log file
• Stats log file
• Logging Options
• Execution Log
• Execution Analyzer
• XLG Debugger
• Cache Miss Analysis

Troubleshooting

• DX Error Codes
• Common Issues