The CMake Package
NAME
turborel-cpp: the CMake package and target a program builds against.
SYNOPSIS
find_package(turborel-cpp 0.0.0 EXACT CONFIG REQUIRED) # an installed package
add_subdirectory(turborel-cpp) # the source in the tree
FetchContent_MakeAvailable(turborel-cpp) # the source fetched
target_link_libraries(app PRIVATE turborel::turborel-cpp)
DESCRIPTION
turborel::turborel-cpp is the library, its headers and its C++20
requirement, got in any of the three ways above. The installed package
matches only its exact version, the Turborel release it is made for
(Appendix D: Versions). The library is
static, or shared where BUILD_SHARED_LIBS is on.
The library wraps turborel-c, the C driver, whose CMake package
turborel and target turborel::turborel it links. An installed
turborel-c of the same release is found first; failing that, turborel-c
is fetched at the commit the driver pins and built into the library,
static. A checkout of turborel-c's own is built instead where CMake's
FETCHCONTENT_SOURCE_DIR_TURBOREL names it. turborel-c brings the TLS
library, OpenSSL 3.5 or later or AWS-LC, and zlib, as its own manual
says.
| Option | What it does | Default |
|---|---|---|
TURBOREL_CPP_BUILD_TESTS |
Builds the tests and the checks that run as tests | on when turborel-cpp is the top project |
TURBOREL_CPP_INSTALL |
Generates the install rules and the CMake package | on |
TURBOREL_CPP_FAULTS |
Builds the turborel-c it fetches so the tests may fail its allocations; never for a library a program uses | off |
TURBOREL_CPP_LINT |
Runs clang-tidy as it builds, and the format and doc checks | off |
TURBOREL_CPP_REQUIRE_DOXYGEN |
Fails to configure without Doxygen when linting | off |
TURBOREL_CPP_SANITIZE |
Builds with AddressSanitizer and UndefinedBehaviorSanitizer | off |
TURBOREL_CPP_COVERAGE |
Builds with Clang's source-based coverage | off |
CMakePresets.json names five builds, each in build/<preset>/, and a
workflow of each that configures, builds and tests: debug, release,
asan-ubsan, coverage and verify, as cmake --workflow --preset release.
ERRORS
find_package fails, as CMake fails a required package, where no
installed package of the exact version is found, of turborel-cpp or of
the turborel-c it was built with.
EXAMPLES
cmake --workflow --preset release
cmake --install build/release --prefix /usr/local
STANDARD
The driver's own (RULES.md D9).