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 TODO: groom
• Why BuildXL? TODO: groom
• Core Concepts TODO: author
• Demos TODO: groom

Project Documentation

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

Product Documentation

Architecture

• Overview TODO: author
• Sandboxing TODO: groom

Setting up a build

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

Build Execution

• Filtering TODO: groom
• Cache Algorithm TODO: author
• Content and Metadata Cache TODO: groom
• Paged Hashes TODO: groom
• Filesystem modes and enumerations TODO: groom
• Incremental Scheduling TODO: groom
• Cancellation
• Resource tuning todo: groom
• Pip Weight TODO: groom
• Scheduler Prioritization TODO: groom
• Server Mode TODO: groom
• Timestamp Faking TODO: groom
• Symlinks and Junctions TODO: groom
• Service Pips
• Pip requested file materialization

Logging and Analysis

• Console Output
• Log Files todo: groom
• Primary log file todo: groom
• Stats log file todo: groom
• Logging Options todo: groom
• Execution Log TODO: groom
• Execution Analyzer TODO: groom
• Cache Miss Analysis TODO: groom

Troubleshooting

• DX Error Codes
• Common Issues