Skip to content

Commit

Permalink
Updated documentation for CLion Setup (#881)
Browse files Browse the repository at this point in the history
I noticed that the documentation for the CLion setup is a bit outdated and has some minor mistakes.

This PR synchronizes the documentation with what the build scripts (build_setup.sh) set as options for compilation.

---------

Co-authored-by: Lukas Abelt <[email protected]>
  • Loading branch information
LuAbelt and Lukas Abelt authored Apr 8, 2024
1 parent 982bf9b commit b7f2480
Showing 1 changed file with 20 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,31 @@ How to set up VaRA/LLVM in CLion
-DBUILD_SHARED_LIBS=ON
-DCMAKE_C_FLAGS_DEBUG="-O2 -g -fno-omit-frame-pointer"
-DCMAKE_CXX_FLAGS_DEBUG="-O2 -g -fno-omit-frame-pointer"
-DCMAKE_SHARED_LINKER_FLAGS="-Wl,--undefined-version"
-DCMAKE_CXX_STANDARD=17
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-DCMAKE_INSTALL_PREFIX=<varats_root>/tools/VaRA
-DLLVM_ENABLE_ASSERTIONS=ON
-DLLVM_ENABLE_BINDINGS=OFF
-DLLVM_ENABLE_EH=ON
-DLLVM_ENABLE_LDD=ON
-DLLVM_ENABLE_LLD=ON
-DLLVM_ENABLE_PROJECTS="clang;lld;compiler-rt;clang-tools-extra;vara;phasar"
-DLLVM_ENABLE_RTTI=ON
-DLLVM_OPTIMIZED_TABLEGEN=ON
-DLLVM_PARALLEL_LINK_JOBS=4
-DLLVM_PHASAR_BUILD=ON
-DLLVM_TOOL_PHASAR_BUILD=ON
-DPHASAR_ENABLE_DYNAMIC_LOG=OFF
-DPHASAR_BUILD_IR=OFF
-DPHASAR_BUILD_UNITTESTS=OFF
-DLLVM_TARGETS_TO_BUILD=X86
-DLLVM_TOOL_PHASAR_BUILD=ON
-DLLVM_USE_NEWPM=ON
-DUSE_HTTPS=OFF
-DUSE_SSH=OFF
-DVARA_BUILD_LIBGIT=ON
-DVARA_FEATURE_BUILD_PYTHON_BINDINGS=OFF
-DVARA_FEATURE_BUILD_Z3_SOLVER=ON
-DVARA_FEATURE_USE_Z3_SOLVER=ON
Use ``-O0`` for debug builds and ``-O2`` for development builds.

Expand All @@ -57,22 +64,31 @@ How to set up VaRA/LLVM in CLion
-DBUILD_SHARED_LIBS=ON
-DCMAKE_C_FLAGS_RELEASE="-O3 -DNDEBUG -march=native -fno-omit-frame-pointer -gmlt"
-DCMAKE_CXX_FLAGS_RELEASE="-O3 -DNDEBUG -march=native -fno-omit-frame-pointer -gmlt"
-DCMAKE_SHARED_LINKER_FLAGS="-Wl,--undefined-version"
-DCMAKE_CXX_STANDARD=17
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-DCMAKE_INSTALL_PREFIX=<varats_root>/tools/VaRA
-DLLVM_ENABLE_ASSERTIONS=OFF
-DLLVM_ENABLE_BINDINGS=OFF
-DLLVM_ENABLE_EH=ON
-DLLVM_ENABLE_LDD=ON
-DLLVM_ENABLE_LLD=ON
-DLLVM_ENABLE_PROJECTS="clang;lld;compiler-rt;clang-tools-extra;vara;phasar"
-DLLVM_ENABLE_RTTI=ON
-DLLVM_OPTIMIZED_TABLEGEN=ON
-DLLVM_PARALLEL_LINK_JOBS=4
-DLLVM_PHASAR_BUILD=ON
-DLLVM_TOOL_PHASAR_BUILD=ON
-DPHASAR_ENABLE_DYNAMIC_LOG=OFF
-DPHASAR_BUILD_IR=OFF
-DPHASAR_BUILD_UNITTESTS=OFF
-DLLVM_TARGETS_TO_BUILD=X86
-DLLVM_TOOL_PHASAR_BUILD=ON
-DLLVM_USE_NEWPM=ON
-DUSE_HTTPS=OFF
-DUSE_SSH=OFF
-DVARA_BUILD_LIBGIT=ON
-DVARA_FEATURE_BUILD_PYTHON_BINDINGS=OFF
-DVARA_FEATURE_BUILD_Z3_SOLVER=ON
-DVARA_FEATURE_USE_Z3_SOLVER=ON
- **Build directory:** ``<varats_root>/tools_src/vara-llvm-project/build/dev-clion``
- **Build options:** leave empty
Expand Down

0 comments on commit b7f2480

Please sign in to comment.