10ca73c02c
ac1ccc5bd9build: Add CTAD feature check (Pol Espinasa)9f273f1c1cbuild: Add path to doc recommended versions for CLANG, GCC and MSVC (Pol Espinasa) Pull request description: Adds a compiler features check. If failed, it returns a fatal error. This early stop at configure time will avoid contributors losing time trying to fix compilation errors because of not fitting the requirements. Example of the output for GCC: Version requirement satisfied: ``` $ cmake -B build -- The CXX compiler identification is GNU 13.3.0 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: /usr/bin/c++ - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done ... -- Checking for required C++ features -- Checking for required C++ features - done .... ``` Compiler feature requirement not satisfied: ``` $ cmake -B build -DCMAKE_C_COMPILER=/usr/bin/gcc-10 -DCMAKE_CXX_COMPILER=/usr/bin/g++-10 -- The CXX compiler identification is GNU 10.5.0 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: /usr/bin/g++-10 - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done -- Setting build type to "RelWithDebInfo" as none was specified -- Performing Test CXX_SUPPORTS__WERROR -- Performing Test CXX_SUPPORTS__WERROR - Success -- Found SQLite3: /usr/include (found suitable version "3.45.1", minimum required is "3.7.17") -- Checking for required C++ features CMake Error at cmake/module/CheckCXXFeatures.cmake:32 (message): Compiler lacks Class Template Argument Deduction (CTAD) for aggregates. This C++ feature is required for src/util/overloaded.h. You are probably using an old compiler version The recommended compiler versions can be checked in: - GCC -> doc/dependencies.md#compiler - Clang -> doc/dependencies.md#compiler - MSVC -> doc/build-windows-msvc.md Call Stack (most recent call first): CMakeLists.txt:198 (check_cxx_features) -- Configuring incomplete, errors occurred! ``` Example of the output for Clang: Compiler feature requirement satisfied: ``` $ cmake -B build -DCMAKE_C_COMPILER=clang-20 -DCMAKE_CXX_COMPILER=clang++-20 -- The CXX compiler identification is Clang 20.1.2 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: /usr/bin/clang++-20 - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done ... -- Checking for required C++ features -- Checking for required C++ features - done ... ``` Compiler feature requirement not satisfied: ``` $ cmake -B build -DCMAKE_C_COMPILER=clang-16 -DCMAKE_CXX_COMPILER=clang++-16 -- The CXX compiler identification is Clang 16.0.6 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: /usr/bin/clang++-16 - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done -- Setting build type to "RelWithDebInfo" as none was specified -- Performing Test CXX_SUPPORTS__WERROR -- Performing Test CXX_SUPPORTS__WERROR - Success -- Performing Test CXX_SUPPORTS__G3 -- Performing Test CXX_SUPPORTS__G3 - Success -- Performing Test LINKER_SUPPORTS__G3 -- Performing Test LINKER_SUPPORTS__G3 - Success -- Performing Test CXX_SUPPORTS__FTRAPV -- Performing Test CXX_SUPPORTS__FTRAPV - Success -- Performing Test LINKER_SUPPORTS__FTRAPV -- Performing Test LINKER_SUPPORTS__FTRAPV - Success -- Found SQLite3: /usr/include (found suitable version "3.45.1", minimum required is "3.7.17") -- Checking for required C++ features CMake Error at cmake/module/CheckCXXFeatures.cmake:32 (message): Compiler lacks Class Template Argument Deduction (CTAD) for aggregates. This C++ feature is required for src/util/overloaded.h. You are probably using an old compiler version The recommended compiler versions can be checked in: - GCC -> doc/dependencies.md#compiler - Clang -> doc/dependencies.md#compiler - MSVC -> doc/build-windows-msvc.md Call Stack (most recent call first): CMakeLists.txt:198 (check_cxx_features) -- Configuring incomplete, errors occurred! ``` Edit: The first version of the PR was to check hardcoded compiler versions. See previous PR description for context here. <details> Adds a compiler minimum version check. If failed, it returns a fatal error. This early stop at configure time will avoid contributors losing time trying to fix compilation errors because of not fitting the requirements. Example of the output for GCC: Version requirement satisfied: ``` sliv3r@sliv3r-tuxedo:~/Documentos/Projectes/BitcoinCore/bitcoin$ cmake -B BUILD -- The CXX compiler identification is GNU 13.3.0 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done .... ``` Version requirement not satisfied: ``` $ cmake -B build -S . -DCMAKE_C_COMPILER=/usr/bin/gcc-11 -DCMAKE_CXX_COMPILER=/usr/bin/g++-11 -- The CXX compiler identification is GNU 11.5.0 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: /usr/bin/g++-11 - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done CMake Error at CMakeLists.txt:91 (message): GCC >= 12.1 required. -- Configuring incomplete, errors occurred! ``` Example of the output for Clang: Version requirement satisfied: ``` sliv3r@sliv3r-tuxedo:~/Documentos/Projectes/BitcoinCore/bitcoin$ cmake -B build -- The CXX compiler identification is Clang 18.1.3 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done ... ``` Version requirement not satisfied: ``` $ cmake -B build -DCMAKE_C_COMPILER=clang-16 -DCMAKE_CXX_COMPILER=clang++-16 -- The CXX compiler identification is Clang 16.0.6 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: /usr/bin/clang++-16 - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done CMake Error at CMakeLists.txt:86 (message): Clang >= 17.0 required. -- Configuring incomplete, errors occurred! ``` <\detail> ACKs for top commit: davidgumberg: crACKac1ccc5bd9achow101: ACKac1ccc5bd9vasild: ACKac1ccc5bd9w0xlt: ACKac1ccc5bd9ryanofsky: Code review ACKac1ccc5bd9. Very much agree with all the previous comments to not check specific compiler versions, and glad this PR is in better shape now. Tree-SHA512: 15a12f56016846427ed8273406c3e9a52a6435bf7033c8fef82bb0e6c9fd75d40a62c79d33f9dd6da8717500f21a629da07620f160b3d43368dd7579f773b4bc
Bitcoin Core integration/staging tree
For an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/.
What is Bitcoin Core?
Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully validate blocks and transactions. It also includes a wallet and graphical user interface, which can be optionally built.
Further information about Bitcoin Core is available in the doc folder.
License
Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/license/MIT.
Development Process
The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be
completely stable. Tags are created
regularly from release branches to indicate new official, stable release versions of Bitcoin Core.
The https://github.com/bitcoin-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.
The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.
Testing
Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.
Automated Testing
Developers are strongly encouraged to write unit tests for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled during the generation of the build system) with: ctest. Further details on running
and extending unit tests can be found in /src/test/README.md.
There are also regression and integration tests, written
in Python.
These tests can be run (if the test dependencies are installed) with: build/test/functional/test_runner.py
(assuming build is your build directory).
The CI (Continuous Integration) systems make sure that every pull request is tested on Windows, Linux, and macOS. The CI must pass on all commits before merge to avoid unrelated CI failures on new pull requests.
Manual Quality Assurance (QA) Testing
Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.
Translations
Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.
Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.
Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.