From b50f8508f25bf396f590f4395fea0d19fefb576d Mon Sep 17 00:00:00 2001 From: Nikolaj Bjorner Date: Mon, 18 Nov 2019 20:50:53 -0800 Subject: [PATCH] rename additional build options #2709 Signed-off-by: Nikolaj Bjorner --- CMakeLists.txt | 10 +++++----- README-CMake.md | 8 ++++---- cmake/compiler_lto.cmake | 8 ++++---- contrib/ci/scripts/build_z3_cmake.sh | 4 ++-- doc/CMakeLists.txt | 6 +++--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index bfbc6ea0c..57f743708 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -392,12 +392,12 @@ include(${PROJECT_SOURCE_DIR}/cmake/compiler_lto.cmake) ################################################################################ # Control flow integrity ################################################################################ -option(ENABLE_CFI "Enable control flow integrity checking" OFF) -if (ENABLE_CFI) +option(Z3_ENABLE_CFI "Enable control flow integrity checking" OFF) +if (Z3_ENABLE_CFI) set(build_types_with_cfi "RELEASE" "RELWITHDEBINFO") - if (NOT LINK_TIME_OPTIMIZATION) + if (NOT Z3_LINK_TIME_OPTIMIZATION) message(FATAL_ERROR "Cannot enable control flow integrity checking without link-time optimization." - "You should set LINK_TIME_OPTIMIZATION to ON or ENABLE_CFI to OFF.") + "You should set Z3_LINK_TIME_OPTIMIZATION to ON or Z3_ENABLE_CFI to OFF.") endif() if (DEFINED CMAKE_CONFIGURATION_TYPES) # Multi configuration generator @@ -417,7 +417,7 @@ if (ENABLE_CFI) endforeach() else() message(FATAL_ERROR "Can't enable control flow integrity for compiler \"${CMAKE_CXX_COMPILER_ID}\"." - "You should set ENABLE_CFI to OFF or use Clang or MSVC to compile.") + "You should set Z3_ENABLE_CFI to OFF or use Clang or MSVC to compile.") endif() endif() diff --git a/README-CMake.md b/README-CMake.md index 45357fda1..06f32a599 100644 --- a/README-CMake.md +++ b/README-CMake.md @@ -261,11 +261,11 @@ The following useful options can be passed to CMake whilst configuring. * ``Z3_BUILD_DOCUMENTATION`` - BOOL. If set to ``TRUE`` then documentation for the API bindings can be built by invoking the ``api_docs`` target. * ``Z3_INSTALL_API_BINDINGS_DOCUMENTATION`` - BOOL. If set to ``TRUE`` and ``Z3_BUILD_DOCUMENTATION` is ``TRUE`` then documentation for API bindings will be installed when running the ``install`` target. -* ``ALWAYS_BUILD_DOCS`` - BOOL. If set to ``TRUE`` and ``BUILD_DOCUMENTATION`` is ``TRUE`` then documentation for API bindings will always be built. +* ``Z3_ALWAYS_BUILD_DOCS`` - BOOL. If set to ``TRUE`` and ``Z3_BUILD_DOCUMENTATION`` is ``TRUE`` then documentation for API bindings will always be built. Disabling this is useful for faster incremental builds. The documentation can be manually built by invoking the ``api_docs`` target. -* ``LINK_TIME_OPTIMIZATION`` - BOOL. If set to ``TRUE`` link time optimization will be enabled. -* ``ENABLE_CFI`` - BOOL. If set to ``TRUE`` will enable Control Flow Integrity security checks. This is only supported by MSVC and Clang and will - fail on other compilers. This requires LINK_TIME_OPTIMIZATION to also be enabled. +* ``Z3_LINK_TIME_OPTIMIZATION`` - BOOL. If set to ``TRUE`` link time optimization will be enabled. +* ``Z3_ENABLE_CFI`` - BOOL. If set to ``TRUE`` will enable Control Flow Integrity security checks. This is only supported by MSVC and Clang and will + fail on other compilers. This requires Z3_LINK_TIME_OPTIMIZATION to also be enabled. * ``Z3_API_LOG_SYNC`` - BOOL. If set to ``TRUE`` will enable experimental API log sync feature. * ``WARNINGS_AS_ERRORS`` - STRING. If set to ``TRUE`` compiler warnings will be treated as errors. If set to ``False`` compiler warnings will not be treated as errors. If set to ``SERIOUS_ONLY`` a subset of compiler warnings will be treated as errors. diff --git a/cmake/compiler_lto.cmake b/cmake/compiler_lto.cmake index b4eb83e18..1fa7ca8d3 100644 --- a/cmake/compiler_lto.cmake +++ b/cmake/compiler_lto.cmake @@ -1,6 +1,6 @@ -option(LINK_TIME_OPTIMIZATION "Use link time optimiziation" OFF) +option(Z3_LINK_TIME_OPTIMIZATION "Use link time optimiziation" OFF) -if (LINK_TIME_OPTIMIZATION) +if (Z3_LINK_TIME_OPTIMIZATION) message(STATUS "LTO enabled") set(build_types_with_lto "RELEASE" "RELWITHDEBINFO") if (DEFINED CMAKE_CONFIGURATION_TYPES) @@ -12,7 +12,7 @@ if (LINK_TIME_OPTIMIZATION) list(FIND build_types_with_lto "${_build_type_upper}" _index) if ("${_index}" EQUAL -1) message(FATAL_ERROR "Configuration ${CMAKE_BUILD_TYPE} does not support LTO." - "You should set LINK_TIME_OPTIMIZATION to OFF.") + "You should set Z3_LINK_TIME_OPTIMIZATION to OFF.") endif() endif() @@ -27,7 +27,7 @@ if (LINK_TIME_OPTIMIZATION) set(_lto_linker_flag "/LTCG") else() message(FATAL_ERROR "Can't enable LTO for compiler \"${CMAKE_CXX_COMPILER_ID}\"." - "You should set LINK_TIME_OPTIMIZATION to OFF.") + "You should set Z3_LINK_TIME_OPTIMIZATION to OFF.") endif() CHECK_CXX_COMPILER_FLAG("${_lto_compiler_flag}" HAS_LTO) if (NOT HAS_LTO) diff --git a/contrib/ci/scripts/build_z3_cmake.sh b/contrib/ci/scripts/build_z3_cmake.sh index 1fd0aa15d..bf1376eb4 100755 --- a/contrib/ci/scripts/build_z3_cmake.sh +++ b/contrib/ci/scripts/build_z3_cmake.sh @@ -41,9 +41,9 @@ fi # Use link time optimziation? if [ "X${USE_LTO}" = "X1" ]; then - ADDITIONAL_Z3_OPTS+=('-DLINK_TIME_OPTIMIZATION=ON') + ADDITIONAL_Z3_OPTS+=('-DZ3_LINK_TIME_OPTIMIZATION=ON') else - ADDITIONAL_Z3_OPTS+=('-DLINK_TIME_OPTIMIZATION=OFF') + ADDITIONAL_Z3_OPTS+=('-DZ3_LINK_TIME_OPTIMIZATION=OFF') fi # Build API docs? diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index fdb0bf8e1..352593547 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -41,8 +41,8 @@ else() list(APPEND JAVA_API_OPTIONS "--no-java") endif() -option(ALWAYS_BUILD_DOCS "Always build documentation for API bindings" ON) -if (ALWAYS_BUILD_DOCS) +option(Z3_ALWAYS_BUILD_DOCS "Always build documentation for API bindings" ON) +if (Z3_ALWAYS_BUILD_DOCS) set(ALWAYS_BUILD_DOCS_ARG "ALL") else() set(ALWAYS_BUILD_DOCS_ARG "") @@ -51,7 +51,7 @@ else() message(WARNING "Building documentation for API bindings is not part of the" " all target. This may result in stale files being installed when running" " the install target. You should run the api_docs target before running" - " the install target. Alternatively Set ALWAYS_BUILD_DOCS to ON to" + " the install target. Alternatively Set Z3_ALWAYS_BUILD_DOCS to ON to" " automatically build documentation when running the install target." ) endif()