From 007ef193c5303d095061ab38ad6b8770679280ec Mon Sep 17 00:00:00 2001 From: Patrick Stotko Date: Thu, 13 Feb 2020 16:07:11 +0100 Subject: [PATCH] General: Deprecate misleading/obsolete cmake options --- README.md | 8 ++++---- cmake/config_summary.cmake | 8 ++++---- doc/stdgpu/index.doxy | 8 ++++---- src/stdgpu/CMakeLists.txt | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 963414252..c96163ffc 100644 --- a/README.md +++ b/README.md @@ -155,12 +155,12 @@ In addition, the implementation of some functionality can be controlled via conf Configuration Option | Effect | Default --- | --- | --- -`STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING` | Enable warnings when auxiliary arrays are allocated in memory API | `OFF` +`STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING` | Enable warnings when auxiliary arrays are allocated in memory API (**deprecated**) | `OFF` `STDGPU_ENABLE_CONTRACT_CHECKS` | Enable contract checks | `OFF` if `CMAKE_BUILD_TYPE` equals `Release` or `MinSizeRel`, `ON` otherwise -`STDGPU_ENABLE_MANAGED_ARRAY_WARNING` | Enable warnings when managed memory is initialized on the host side but should be on device in memory API | `OFF` +`STDGPU_ENABLE_MANAGED_ARRAY_WARNING` | Enable warnings when managed memory is initialized on the host side but should be on device in memory API (**deprecated**) | `OFF` `STDGPU_USE_32_BIT_INDEX` | Use 32-bit instead of 64-bit signed integer for `index_t` | `ON` -`STDGPU_USE_FAST_DESTROY` | Use fast destruction of allocated arrays (filled with a default value) by omitting destructor calls in memory API | `OFF` -`STDGPU_USE_FIBONACCI_HASHING` | Use Fibonacci Hashing instead of Modulo to compute hash bucket indices | `ON` +`STDGPU_USE_FAST_DESTROY` | Use fast destruction of allocated arrays (filled with a default value) by omitting destructor calls in memory API (**deprecated**) | `OFF` +`STDGPU_USE_FIBONACCI_HASHING` | Use Fibonacci Hashing instead of Modulo to compute hash bucket indices (**deprecated**) | `ON` ### Examples diff --git a/cmake/config_summary.cmake b/cmake/config_summary.cmake index bfcf2e573..12eb40b19 100644 --- a/cmake/config_summary.cmake +++ b/cmake/config_summary.cmake @@ -18,12 +18,12 @@ function(stdgpu_print_configuration_summary) message(STATUS "") message(STATUS "Configuration:") - message(STATUS " STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING : ${STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING}") + message(STATUS " STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING : [deprecated] ${STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING}") message(STATUS " STDGPU_ENABLE_CONTRACT_CHECKS : ${STDGPU_ENABLE_CONTRACT_CHECKS} (depends on build type)") - message(STATUS " STDGPU_ENABLE_MANAGED_ARRAY_WARNING : ${STDGPU_ENABLE_MANAGED_ARRAY_WARNING}") + message(STATUS " STDGPU_ENABLE_MANAGED_ARRAY_WARNING : [deprecated] ${STDGPU_ENABLE_MANAGED_ARRAY_WARNING}") message(STATUS " STDGPU_USE_32_BIT_INDEX : ${STDGPU_USE_32_BIT_INDEX}") - message(STATUS " STDGPU_USE_FAST_DESTROY : ${STDGPU_USE_FAST_DESTROY}") - message(STATUS " STDGPU_USE_FIBONACCI_HASHING : ${STDGPU_USE_FIBONACCI_HASHING}") + message(STATUS " STDGPU_USE_FAST_DESTROY : [deprecated] ${STDGPU_USE_FAST_DESTROY}") + message(STATUS " STDGPU_USE_FIBONACCI_HASHING : [deprecated] ${STDGPU_USE_FIBONACCI_HASHING}") message(STATUS "") diff --git a/doc/stdgpu/index.doxy b/doc/stdgpu/index.doxy index f3f4a24e3..2902edc83 100644 --- a/doc/stdgpu/index.doxy +++ b/doc/stdgpu/index.doxy @@ -111,12 +111,12 @@ In addition, the implementation of some functionality can be controlled via conf Configuration Option | Effect | Default --- | --- | --- -`STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING` | Enable warnings when auxiliary arrays are allocated in memory API | `OFF` +`STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING` | Enable warnings when auxiliary arrays are allocated in memory API (**deprecated**) | `OFF` `STDGPU_ENABLE_CONTRACT_CHECKS` | Enable contract checks | `OFF` if `CMAKE_BUILD_TYPE` equals `Release` or `MinSizeRel`, `ON` otherwise -`STDGPU_ENABLE_MANAGED_ARRAY_WARNING` | Enable warnings when managed memory is initialized on the host side but should be on device in memory API | `OFF` +`STDGPU_ENABLE_MANAGED_ARRAY_WARNING` | Enable warnings when managed memory is initialized on the host side but should be on device in memory API (**deprecated**) | `OFF` `STDGPU_USE_32_BIT_INDEX` | Use 32-bit instead of 64-bit signed integer for `index_t` | `ON` -`STDGPU_USE_FAST_DESTROY` | Use fast destruction of allocated arrays (filled with a default value) by omitting destructor calls in memory API | `OFF` -`STDGPU_USE_FIBONACCI_HASHING` | Use Fibonacci Hashing instead of Modulo to compute hash bucket indices | `ON` +`STDGPU_USE_FAST_DESTROY` | Use fast destruction of allocated arrays (filled with a default value) by omitting destructor calls in memory API (**deprecated**) | `OFF` +`STDGPU_USE_FIBONACCI_HASHING` | Use Fibonacci Hashing instead of Modulo to compute hash bucket indices (**deprecated**) | `ON` \subsection examples Examples diff --git a/src/stdgpu/CMakeLists.txt b/src/stdgpu/CMakeLists.txt index 8f924197b..605b116b8 100644 --- a/src/stdgpu/CMakeLists.txt +++ b/src/stdgpu/CMakeLists.txt @@ -20,12 +20,12 @@ else() set(STDGPU_ENABLE_CONTRACT_CHECKS_DEFAULT ON) endif() -option(STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING "Enable warnings when auxiliary arrays are allocated in memory API, default: OFF" OFF) +option(STDGPU_ENABLE_AUXILIARY_ARRAY_WARNING "Enable warnings when auxiliary arrays are allocated in memory API (deprecated), default: OFF" OFF) option(STDGPU_ENABLE_CONTRACT_CHECKS "Enable contract checks, default: OFF if CMAKE_BUILD_TYPE is Release or MinSizeRel, ON otherwise" ${STDGPU_ENABLE_CONTRACT_CHECKS_DEFAULT}) -option(STDGPU_ENABLE_MANAGED_ARRAY_WARNING "Enable warnings when managed memory is initialized on the host side but should be on device in memory API, default: OFF" OFF) +option(STDGPU_ENABLE_MANAGED_ARRAY_WARNING "Enable warnings when managed memory is initialized on the host side but should be on device in memory API (deprecated), default: OFF" OFF) option(STDGPU_USE_32_BIT_INDEX "Use 32-bit instead of 64-bit signed integer for index_t, default: ON" ON) -option(STDGPU_USE_FAST_DESTROY "Use fast destruction of allocated arrays (filled with a default value) by omitting destructor calls in memory API, default: OFF" OFF) -option(STDGPU_USE_FIBONACCI_HASHING "Use Fibonacci Hashing instead of Modulo to compute hash bucket indices, default: ON" ON) +option(STDGPU_USE_FAST_DESTROY "Use fast destruction of allocated arrays (filled with a default value) by omitting destructor calls in memory API (deprecated), default: OFF" OFF) +option(STDGPU_USE_FIBONACCI_HASHING "Use Fibonacci Hashing instead of Modulo to compute hash bucket indices (deprecated), default: ON" ON) configure_file("${STDGPU_INCLUDE_LOCAL_DIR}/stdgpu/config.h.in" "${STDGPU_BUILD_INCLUDE_DIR}/stdgpu/config.h")