Skip to content

build: Introduce CMake-based build system

Placeholder Hennadii Stepanov requested to merge github/fork/hebasto/240716-cmake into master

This PR introduces a new CMake-based build system, which is a drop-in replacement for the current Autotools-based build system.

ML announcement: https://groups.google.com/g/bitcoindev/c/hgKkfQWzrTo

As discussed during the recent CoreDev meetup in April, the switch from Autotools to CMake is intended to happen as soon as possible after branching 28.x off, which means that 29.0 will be built using CMake.

This PR branch is essentially the staging branch, with every change reviewed and tested by a group of contributors, including (in alphabetical order):

Reviewing in a separate staging repo was suggested in https://github.com/bitcoin/bitcoin/pull/27060#issuecomment-1431798320.

The accompanying changes to the OSS-Fuzz project are available in https://github.com/hebasto/oss-fuzz/pull/8.

Please refer to the build options parity table. The "auto" value is no longer available; non-default values must be specified explicitly. Additionally, the new default values have been chosen to suit the everyday build experience for the majority of developers.

System requirements for using the CMake-based build system:

  • CMake >= 3.22 (if not available in your system's repository, it can be downloaded from https://cmake.org/download/)
  • a build tool of your choice:
    • any Make (GNU Make is no longer a requirement); GNU Make is still required to build depends
    • Ninja (https://ninja-build.org/)
    • MSBuild
    • Xcode

A note for Windows users: The default installation of the latest version of MSVC 17.10.4 includes both CMake 3.28.3 and the vcpkg package manager).

We, the build system developers, kindly ask reviewers to refrain from making suggestions that are not directly related to the migration process or can be implemented separately. Bugs in the scripts and errors in the updated documentation should be the focus of this PR. Please be advised that comments not aligned with this PR's goal may be ignored.

Thank you all for your understanding.

Merge request reports