Buildsystem - rename CMake option ICAL_GLIB to LIBICAL_GLIB (libical#1013)

libicalGH-380

Author: winterz

.github/workflows/build.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Configure project
         run: |
           mkdir build
-          cmake -B build --warn-uninitialized -Werror=dev -G Ninja -DLIBICAL_DEVMODE_MEMORY_CONSISTENCY=True -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DLIBICAL_DEVMODE=True -DLIBICAL_GLIB_BUILD_DOCS=False -DICAL_GLIB=False -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB_VAPI=False
+          cmake -B build --warn-uninitialized -Werror=dev -G Ninja -DLIBICAL_DEVMODE_MEMORY_CONSISTENCY=True -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DLIBICAL_DEVMODE=True -DLIBICAL_GLIB_BUILD_DOCS=False -DLIBICAL_GLIB=False -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB_VAPI=False
         shell: cmd
       - name: Build project
         run: cmake --build build
@@ -43,7 +43,7 @@ jobs:
       - name: Configure project
         run: |
           mkdir build
-          cmake -B build --warn-uninitialized -Werror=dev -G Ninja -DLIBICAL_DEVMODE_MEMORY_CONSISTENCY=False -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DLIBICAL_DEVMODE=True -DLIBICAL_GLIB_BUILD_DOCS=True -DICAL_GLIB=True -DGOBJECT_INTROSPECTION=True -DLIBICAL_GLIB_VAPI=True -DLIBICAL_BUILD_TESTING_BIGFUZZ=True
+          cmake -B build --warn-uninitialized -Werror=dev -G Ninja -DLIBICAL_DEVMODE_MEMORY_CONSISTENCY=False -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DLIBICAL_DEVMODE=True -DLIBICAL_GLIB_BUILD_DOCS=True -DLIBICAL_GLIB=True -DGOBJECT_INTROSPECTION=True -DLIBICAL_GLIB_VAPI=True -DLIBICAL_BUILD_TESTING_BIGFUZZ=True
       - name: Build project
         run: cmake --build build
       - name: Test project
@@ -66,7 +66,7 @@ jobs:
         run: |
           export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
           mkdir build
-          cmake -B build --warn-uninitialized -Werror=dev -G Ninja -DLIBICAL_DEVMODE_MEMORY_CONSISTENCY=False -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DLIBICAL_DEVMODE=True -DLIBICAL_GLIB_BUILD_DOCS=False -DICAL_GLIB=True -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB_VAPI=False -DLIBICAL_BUILD_TESTING_BIGFUZZ=True
+          cmake -B build --warn-uninitialized -Werror=dev -G Ninja -DLIBICAL_DEVMODE_MEMORY_CONSISTENCY=False -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DLIBICAL_DEVMODE=True -DLIBICAL_GLIB_BUILD_DOCS=False -DLIBICAL_GLIB=True -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB_VAPI=False -DLIBICAL_BUILD_TESTING_BIGFUZZ=True
       - name: Build project
         run: cmake --build build
       - name: Test project

CMakeLists.txt

@@ -58,7 +58,7 @@
 #  Requires Vala package
 #  Default=false (build the libical-glib interface)
 #
-# -DICAL_GLIB=[true|false]
+# -DLIBICAL_GLIB=[true|false]
 #  Set to build libical-glib (GObject) interface
 #  Requires glib 2.0 development package (version MIN_GLIB).
 #  Requires libxml2.0 development package (version MIN_LIBXML).
@@ -683,19 +683,20 @@ endif()
 
 set(MIN_GLIB "2.44")
 set(MIN_LIBXML "2.7.3")
-libical_option(
+libical_deprecated_option(
   ICAL_GLIB
+  LIBICAL_GLIB
   "Build libical-glib interface. \
   Requires glib ${MIN_GLIB} and libxml ${MIN_LIBXML} development packages or higher."
   True
 )
-if(ICAL_GLIB)
+if(LIBICAL_GLIB)
   if(NOT PKG_CONFIG_FOUND)
     message(
       FATAL_ERROR
       "You requested to build libical-glib, however that option is not supported "
       "unless pkg-config can be found. Please install pkg-config and try again. "
-      "Alternatively, disable the libical-glib build (by passing -DICAL_GLIB=False to cmake)."
+      "Alternatively, disable the libical-glib build (by passing -DLIBICAL_GLIB=False to cmake)."
     )
   endif()
 
@@ -728,22 +729,22 @@ if(ICAL_GLIB)
       FATAL_ERROR
       "You requested to build libical-glib, but the necessary development package "
       "is missing or too low a version (libxml ${MIN_LIBXML} or higher is required). "
-      "Alternatively, disable the libical-glib build (by passing -DICAL_GLIB=False to cmake)."
+      "Alternatively, disable the libical-glib build (by passing -DLIBICAL_GLIB=False to cmake)."
     )
   elseif(LIBXML_FOUND)
     message(
       FATAL_ERROR
       "You requested to build libical-glib, but the necessary development package "
       "is missing or too low a version (glib ${MIN_GLIB} or higher is required. "
-      "Alternatively, disable the libical-glib build (by passing -DICAL_GLIB=False to cmake)."
+      "Alternatively, disable the libical-glib build (by passing -DLIBICAL_GLIB=False to cmake)."
     )
   else()
     message(
       FATAL_ERROR
       "You requested to build libical-glib, but the necessary development packages "
       "are missing or too low a version "
       "(glib ${MIN_GLIB} and libxml ${MIN_LIBXML} or higher are required). "
-      "Alternatively, disable the libical-glib build (by passing -DICAL_GLIB=False to cmake)."
+      "Alternatively, disable the libical-glib build (by passing -DLIBICAL_GLIB=False to cmake)."
     )
   endif()
 endif()
@@ -884,7 +885,7 @@ if(LIBICAL_DEVMODE_LEAK_SANITIZER)
       "Currently unable to build leak sanitizer for glib-based configurations."
       "Disabling GLib and GLib docs, GObject_Introspection and VALA support."
     )
-    set(ICAL_GLIB False)
+    set(LIBICAL_GLIB False)
     set(GOBJECT_INTROSPECTION False)
     set(LIBICAL_GLIB_BUILD_DOCS False)
     set(LIBICAL_GLIB_VAPI False)
@@ -914,7 +915,7 @@ if(LIBICAL_DEVMODE_MEMORY_SANITIZER)
       "Currently unable to build memory sanitizer for glib-based configurations."
       "Disabling GLib and GLib docs, GObject_Introspection and VALA support."
     )
-    set(ICAL_GLIB False)
+    set(LIBICAL_GLIB False)
     set(GOBJECT_INTROSPECTION False)
     set(LIBICAL_GLIB_BUILD_DOCS False)
     set(LIBICAL_GLIB_VAPI False)
@@ -942,7 +943,7 @@ if(LIBICAL_DEVMODE_THREAD_SANITIZER)
       "Currently unable to build thread sanitizer for glib-based configurations."
       "Disabling GLib and GLib docs, GObject_Introspection and VALA support."
     )
-    set(ICAL_GLIB False)
+    set(LIBICAL_GLIB False)
     set(GOBJECT_INTROSPECTION False)
     set(LIBICAL_GLIB_BUILD_DOCS False)
     set(LIBICAL_GLIB_VAPI False)
@@ -1064,11 +1065,11 @@ if(LIBICAL_BUILD_DOCS)
         "you can disable the glib documentation(by passing -DLIBICAL_GLIB_BUILD_DOCS=False to cmake)."
       )
     endif()
-    if(NOT ICAL_GLIB)
+    if(NOT LIBICAL_GLIB)
       message(
         FATAL_ERROR
         "You requested to build the libical-glib documentation but have not enabled libical-glib itself. "
-        "Please try again also passing -DICAL_GLIB=True to cmake. Alternatively, "
+        "Please try again also passing -DLIBICAL_GLIB=True to cmake. Alternatively, "
         "you can disable the glib documentation(by passing -DLIBICAL_GLIB_BUILD_DOCS=False to cmake)."
       )
     endif()

docs/MigrationGuide_to_4.md

@@ -13,7 +13,8 @@ User-specific:
 | Old Name             | New Name                            |
 |----------------------|-------------------------------------|
 | ICAL_BUILD_DOCS      | LIBICAL_BUILD_DOCS                  |
-| ICAL_GLIB_VAPI      | LIBICAL_GLIB_VAPI                   |
+| ICAL_GLIB            | LIBICAL_GLIB                        |
+| ICAL_GLIB_VAPI       | LIBICAL_GLIB_VAPI                   |
 | ICAL_GLIB_BUILD_DOCS | LIBICAL_GLIB_BUILD_DOCS             |
 | USE_32BIT_TIME_T     | LIBICAL_ENABLE_MSVC_32BIT_TIME_T    |
 | WITH_CXX_BINDINGS    | LIBICAL_CXX_BINDINGS                |

scripts/buildtests.sh

@@ -857,11 +857,11 @@ fi
 UNSET_NINJA
 
 DEFCMAKEOPTS="-DCMAKE_BUILD_TYPE=Release -DNDEBUG=1"
-CMAKEOPTS="-DLIBICAL_DEVMODE=True -DGOBJECT_INTROSPECTION=False -DICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
+CMAKEOPTS="-DLIBICAL_DEVMODE=True -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
 UUCCMAKEOPTS="$CMAKEOPTS -DCMAKE_DISABLE_FIND_PACKAGE_ICU=True"
 TZCMAKEOPTS="$CMAKEOPTS -DUSE_BUILTIN_TZDATA=True"
 LTOCMAKEOPTS="$CMAKEOPTS -DENABLE_LTO_BUILD=True"
-GLIBOPTS="-DLIBICAL_DEVMODE=True -DICAL_GLIB=True -DGOBJECT_INTROSPECTION=True -DUSE_BUILTIN_TZDATA=OFF -DLIBICAL_GLIB_VAPI=ON"
+GLIBOPTS="-DLIBICAL_DEVMODE=True -DLIBICAL_GLIB=True -DGOBJECT_INTROSPECTION=True -DUSE_BUILTIN_TZDATA=OFF -DLIBICAL_GLIB_VAPI=ON"
 FUZZOPTS="-DLIBICAL_DEVMODE=True -DLIBICAL_BUILD_TESTING_BIGFUZZ=True"
 
 #Static code checkers
@@ -870,7 +870,7 @@ STATICCCHECKOPTS="\
 -DSHARED_ONLY=True \
 -DLIBICAL_CXX_BINDINGS=True \
 -DUSE_BUILTIN_TZDATA=True \
--DICAL_GLIB=True \
+-DLIBICAL_GLIB=True \
 -DGOBJECT_INTROSPECTION=True \
 -DLIBICAL_GLIB_VAPI=True \
 -DLIBICAL_GLIB_BUILD_DOCS=True \
@@ -904,7 +904,7 @@ GCC_BUILD testgcc2builtin "$TZCMAKEOPTS"
 
 #Ninja build tests
 NINJA_GCC_BUILD testninjagcc1 "$DEFCMAKEOPTS"
-NINJA_GCC_BUILD testninjagcc2 "-DICAL_GLIB=True"
+NINJA_GCC_BUILD testninjagcc2 "-DLIBICAL_GLIB=True"
 NINJA_GCC_BUILD testninjagcc3 "-DLIBICAL_GLIB_VAPI=ON"
 NINJA_GCC_BUILD testninjagcc4 "-DSHARED_ONLY=True -DLIBICAL_GLIB_BUILD_DOCS=False"
 NINJA_GCC_BUILD testninjagcc5 "-DSHARED_ONLY=True"
@@ -941,7 +941,7 @@ ASAN_BUILD test6asan "$FUZZOPTS $ASAN_DISABLE"
 
 #Leak sanitizer
 #libical-glib tests fail lsan
-LSAN_DISABLE="-DLIBICAL_JAVA_BINDINGS=OFF -DLIBICAL_GLIB_VAPI=OFF -DGOBJECT_INTROSPECTION=False -DICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
+LSAN_DISABLE="-DLIBICAL_JAVA_BINDINGS=OFF -DLIBICAL_GLIB_VAPI=OFF -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
 LSAN_BUILD test1lsan "$DEFCMAKEOPTS $LSAN_DISABLE"
 LSAN_BUILD test2lsan "$CMAKEOPTS $LSAN_DISABLE"
 LSAN_BUILD test3lsan "$TZCMAKEOPTS $LSAN_DISABLE"
@@ -951,7 +951,7 @@ LSAN_BUILD test6lsan "$FUZZOPTS $LSAN_DISABLE"
 
 #Memory sanitizer
 # currently MSAN fails inside libicu and also isn't working with std:stringstreams properly
-MSAN_DISABLE="-DCMAKE_DISABLE_FIND_PACKAGE_ICU=True -DLIBICAL_CXX_BINDINGS=False -DLIBICAL_JAVA_BINDINGS=OFF -DLIBICAL_GLIB_VAPI=OFF -DGOBJECT_INTROSPECTION=False -DICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
+MSAN_DISABLE="-DCMAKE_DISABLE_FIND_PACKAGE_ICU=True -DLIBICAL_CXX_BINDINGS=False -DLIBICAL_JAVA_BINDINGS=OFF -DLIBICAL_GLIB_VAPI=OFF -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
 MSAN_BUILD test1msan "$DEFCMAKEOPTS $MSAN_DISABLE"
 MSAN_BUILD test2msan "$CMAKEOPTS $MSAN_DISABLE"
 MSAN_BUILD test3msan "$TZCMAKEOPTS $MSAN_DISABLE"
@@ -961,7 +961,7 @@ MSAN_BUILD test6msan "$FUZZOPTS $MSAN_DISABLE"
 
 #Thread sanitizer
 #libical-glib tests fail tsan with /lib64/libtsan.so.2: cannot allocate memory in static TLS block
-TSAN_DISABLE="-DLIBICAL_JAVA_BINDINGS=OFF -DLIBICAL_GLIB_VAPI=OFF -DGOBJECT_INTROSPECTION=False -DICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
+TSAN_DISABLE="-DLIBICAL_JAVA_BINDINGS=OFF -DLIBICAL_GLIB_VAPI=OFF -DGOBJECT_INTROSPECTION=False -DLIBICAL_GLIB=False -DLIBICAL_BUILD_DOCS=False"
 TSAN_BUILD test1tsan "$DEFCMAKEOPTS $TSAN_DISABLE"
 TSAN_BUILD test2tsan "$CMAKEOPTS $TSAN_DISABLE"
 TSAN_BUILD test3tsan "$TZCMAKEOPTS $TSAN_DISABLE"

src/CMakeLists.txt

@@ -4,7 +4,7 @@
 add_subdirectory(libical)
 add_subdirectory(libicalss)
 add_subdirectory(libicalvcal)
-if(ICAL_GLIB)
+if(LIBICAL_GLIB)
   add_subdirectory(libical-glib)
 endif()
 add_subdirectory(libicalvcard)

src/test/CMakeLists.txt

@@ -127,7 +127,7 @@ macro(testme _name _srcs)
 endmacro()
 
 ########## libical-glib tests #########
-if(ICAL_GLIB AND GOBJECT_INTROSPECTION)
+if(LIBICAL_GLIB AND GOBJECT_INTROSPECTION)
   add_subdirectory(libical-glib)
 endif()