Rename UMF_USE_GCOV to UMF_USE_COVERAGE

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

CMakeLists.txt

@@ -71,7 +71,7 @@ option(UMF_USE_UBSAN "Enable UndefinedBehaviorSanitizer checks" OFF)
 option(UMF_USE_TSAN "Enable ThreadSanitizer checks" OFF)
 option(UMF_USE_MSAN "Enable MemorySanitizer checks" OFF)
 option(UMF_USE_VALGRIND "Enable Valgrind instrumentation" OFF)
-option(UMF_USE_GCOV "Enable gcov support" OFF)
+option(UMF_USE_COVERAGE "Build with coverage enabled (Linux only)" OFF)
 
 # set UMF_PROXY_LIB_BASED_ON_POOL to one of: SCALABLE or JEMALLOC
 set(KNOWN_PROXY_LIB_POOLS SCALABLE JEMALLOC)

CONTRIBUTING.md

@@ -209,12 +209,12 @@ origin: https://dependency_origin.com
 ## Code coverage
 
 After adding a new functionality add tests and check coverage before and after the change.
-To do this, enable coverage instrumentation by turning on the UMF_USE_GCOV flag in CMake.
+To do this, enable coverage instrumentation by turning on the UMF_USE_COVERAGE flag in CMake.
 Coverage instrumentation feature is supported only by GCC and Clang.
 An example flow might look like the following:
 
 ```bash
-$ cmake -B build -DUMF_USE_GCOV=1 -DCMAKE_BUILD_TYPE=Debug
+$ cmake -B build -DUMF_USE_COVERAGE=1 -DCMAKE_BUILD_TYPE=Debug
 $ cmake --build build -j
 $ cd build
 $ ctest

README.md

@@ -119,7 +119,7 @@ List of options provided by CMake:
 | UMF_USE_TSAN | Enable ThreadSanitizer checks | ON/OFF | OFF |
 | UMF_USE_MSAN | Enable MemorySanitizer checks | ON/OFF | OFF |
 | UMF_USE_VALGRIND | Enable Valgrind instrumentation | ON/OFF | OFF |
-| UMF_USE_GCOV | Enable gcov support (Linux only) | ON/OFF | OFF |
+| UMF_USE_COVERAGE | Build with coverage enabled (Linux only) | ON/OFF | OFF |
 | UMF_LINK_HWLOC_STATICALLY | Link UMF with HWLOC library statically (Windows+Release only) | ON/OFF | OFF |
 | UMF_DISABLE_HWLOC | Disable features that requires hwloc (OS provider, memory targets, topology discovery) | ON/OFF | OFF |
 

cmake/helpers.cmake

@@ -247,9 +247,12 @@ function(add_umf_target_compile_options name)
             target_compile_options(${name} PRIVATE -fno-omit-frame-pointer
                                                    -fstack-protector-strong)
         endif()
-        if(UMF_USE_GCOV)
+        if(UMF_USE_COVERAGE)
             if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
-                message(FATAL_ERROR "To use gcov, the build type must be Debug")
+                message(
+                    FATAL_ERROR
+                        "To use the --coverage flag, the build type must be Debug"
+                )
             endif()
             target_compile_options(${name} PRIVATE --coverage)
         endif()
@@ -283,10 +286,12 @@ function(add_umf_target_link_options name)
     if(NOT MSVC)
         if(NOT APPLE)
             target_link_options(${name} PRIVATE "LINKER:-z,relro,-z,now")
-            if(UMF_USE_GCOV)
+            if(UMF_USE_COVERAGE)
                 if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
                     message(
-                        FATAL_ERROR "To use gcov, the build type must be Debug")
+                        FATAL_ERROR
+                            "To use the --coverage flag, the build type must be Debug"
+                    )
                 endif()
                 target_link_options(${name} PRIVATE --coverage)
             endif()