Skip to content

CMake flags

Build cache:

This project uses ccache automatically if it's available in the system. To disable this, use flag -DAUTO_CCACHE=OFF

Building tests:

cmake -B build -DSC_BUILD_TESTS=ON -DSC_AUTO_TEST=ON
cmake --build build -j$(nproc)

Additionally you can use -DSC_BUILD_BENCH=ON flag to build performance tests

Building with sanitizers

Use cmake with -DSC_USE_SANITIZER=memory or -DSC_USE_SANITIZER=address option to run build with memory or address sanitizer. Note: sanitizers are only supported by clang compiler

Example:

cmake -B build -DSC_USE_SANITIZER=memory -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang
cmake --build build

Code formatting with CLangFormat:

To check code with CLangFormat run: 

cmake -B build -DSC_CLANG_FORMAT_CODE=ON
cmake --build build --target clangformat_check

or 

./scripts/clang/check_formatting.sh

To format code with CLangFormat run: 

cmake -B build -DSC_CLANG_FORMAT_CODE=ON
cmake --build build --target clangformat

or 

./scripts/clang/format_code.sh