FASTBuild — CMake 4.2.1 Documentation (original) (raw)
Added in version 4.2.
Generates a fbuild.bff file, which can be used to build the project withFASTBuild.
Usage¶
Specify the generator when invoking cmake(1):
cmake [] -G FASTBuild -B [-S ]
This writes a FASTBuild configuration file named fbuild.bff into<path-to-build>.
Note
This generator also produces IDE project files for Visual Studio and Xcode, which are placed under:
<path-to-build>/VisualStudio– Visual Studio solution and projects<path-to-build>/XCode– Xcode workspace and projects
These IDE files can be generated by building xcode or solution targets and will build using FASTBuild as the backend.
Caching¶
To enable FASTBuild caching, set the cache path using theCMAKE_FASTBUILD_CACHE_PATH variable or theFASTBUILD_CACHE_PATH environment variable.
Then build with the -cache flag:
cmake --build -- -cache
Compiler Behavior Variables¶
The following variables control how compiler nodes are emitted in the generatedfbuild.bff. These settings may affect build determinism, debug info paths, include handling, and compiler argument formatting:
- CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE
- CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG
- CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES
- CMAKE_FASTBUILD_COMPILER_EXTRA_FILES
- CMAKE_FASTBUILD_FORCE_RESPONSE_FILE
- CMAKE_FASTBUILD_SOURCE_MAPPING
- CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS
- CMAKE_FASTBUILD_USE_LIGHTCACHE
- CMAKE_FASTBUILD_USE_RELATIVE_PATHS
Configuration Variables¶
The following variables can be used to configure this generator:
- CMAKE_FASTBUILD_CACHE_PATH
- CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV
- CMAKE_FASTBUILD_ENV_OVERRIDES
- CMAKE_FASTBUILD_IDE_ARGS
- CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT
- CMAKE_FASTBUILD_VERBOSE_GENERATOR
Target Properties¶
The following target properties can be used to fine-tune behavior on a per-target basis:
- FASTBUILD_CACHING – disables caching for a specific target.
- FASTBUILD_DISTRIBUTION – disables distributed compilation for a specific target.
Notes¶
- This generator does not support directories as outputs of custom commands. If you do specify a directory as an output, it should be marked with the
SYMBOLICproperty to avoid incorrect behavior. - It is highly advised to use custom commands with only one output. If multiple outputs are specified, the generator will emit an additional rule to check the outputs at build time. This adds overhead and is necessary because FASTBuild natively supports only a single output per custom step.
Example¶
cmake [] -G FASTBuild -B -DCMAKE_BUILD_TYPE=Release cmake --build --target my_app
This generates fbuild.bff in <path-to-build> and uses FASTBuild to build the my_app target.