CMake-Based Build System

We are developing an alternative build system for Boost based on ​CMake, a cross-platform, open-source make system. At this point, the CMake-based build system is still a work in progress, and it is unknown whether it will become a fully-supported build system within Boost. These pages document the CMake-based build system for Boost, and are focused primarily at Boost library developers. In the future, we will provide an alternative version of Boost's Getting Started guide for CMake users.

How Do I…

• Build Boost with CMake?

• Tune the CMake build configuration (verbosity, tests, static/shared, debug/release, single/multi-threaded)?

• Test Boost with CMake?

• Add a Boost Library with CMake?

• Add a Compiled Library with CMake?

• Add Regression Tests with CMake?

• Modularize a Library with CMake?

• Build a Binary Installer with CMake?

Reference Documentation

• Project macros
  • boost_library_project - Designate a new Boost library project

• Building binaries
  • boost_add_library - Add a compiled Boost library
  • boost_add_executable - Add a compiled executable

• Regression testing
  • boost_test_run - Compile and execute a test
  • boost_test_run_fail - Compile and execute a test (which is expected to fail)
  • boost_test_compile - Compile a test
  • boost_test_compile_fail - Compile a test (which should fail to compile)

• Build features - Different library build features supported by the build system

• ​CMake Macro Reference (note that this documentation is also compiled in to cmake itself. The command cmake --help-full will display it.)

Commentary

• Boost CMake Features
• KDE experiences with Cmake

Ongoing Development

• ​Boost-cmake mailing list
• CMake TODO list - Start here to get involved!
• There is a CMake component in trac: keep us abreast of any bugs.