new module ECMSourceVersionControlv5.63.0-rc2v5.63.0-rc1v5.63.0

Summary:
simply sets a variable when the source is under version control. use it to
auto-enable Debug builds. there are also plans to switch special assertion
logic on in KIO when used from git, so there definitely is a more generic
use case of wanting to control behavior based on whether it the source is
likely used to make a development or production build.

conceivably the module could be used in the future to get git rev-parse or
the like, hence the generic name.

Test Plan: with .git the var is true, without it is false

Reviewers: kde-buildsystem, dfaure

Reviewed By: dfaure

Subscribers: apol, kossebau, kde-frameworks-devel

Tags: #frameworks, #build_system

Differential Revision: https://phabricator.kde.org/D24159

3 files changed, 56 insertions, 9 deletions

diff --git a/docs/module/ECMSourceVersionControl.rst b/docs/module/ECMSourceVersionControl.rst
new file mode 100644
index 00000000..c24ad029
--- /dev/null
+++ b/docs/module/ECMSourceVersionControl.rst
@@ -0,0 +1 @@
+.. ecm-module:: ../../modules/ECMSourceVersionControl.cmake
diff --git a/kde-modules/KDECompilerSettings.cmake b/kde-modules/KDECompilerSettings.cmake
index 41a4a2e5..7eb5cd41 100644
--- a/kde-modules/KDECompilerSettings.cmake
+++ b/kde-modules/KDECompilerSettings.cmake
@@ -66,21 +66,21 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+include("${ECM_MODULE_DIR}/ECMSourceVersionControl.cmake")
+
 ############################################################
 # Default build type
 # If no build type was specified, default to using a debug build if the
 # source directory is a git clone.
 # Otherwise, leave it empty, to let distro packagers choose the flags.
 ############################################################
-if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-    if (EXISTS "${CMAKE_SOURCE_DIR}/.git")
-        set(default_build_type "Debug")
-        message(STATUS "Setting build type to '${default_build_type}' as none was specified.")
-        set_property(CACHE CMAKE_BUILD_TYPE PROPERTY VALUE "${default_build_type}")
-        # Set the possible values of build type for cmake-gui
-        set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
-            "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
-    endif()
+if (ECM_SOURCE_UNDER_VERSION_CONTROL AND NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+    set(default_build_type "Debug")
+    message(STATUS "Setting build type to '${default_build_type}' as none was specified.")
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY VALUE "${default_build_type}")
+    # Set the possible values of build type for cmake-gui
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
+        "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
 endif()
 
 ############################################################
diff --git a/modules/ECMSourceVersionControl.cmake b/modules/ECMSourceVersionControl.cmake
new file mode 100644
index 00000000..c792ef91
--- /dev/null
+++ b/modules/ECMSourceVersionControl.cmake
@@ -0,0 +1,46 @@
+#.rst:
+# ECMSourceVersionControl
+# --------------------------
+#
+# Tries to determine whether the source is under version control (git clone,
+# svn checkout, etc).
+#
+# ``ECM_SOURCE_UNDER_VERSION_CONTROL`` is set when indication is found that
+# CMAKE_SOURCE_DIR is under version control.
+#
+# Since 5.63
+
+#=============================================================================
+# Copyright 2019 Harald Sitter <sitter@kde.org>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+if(EXISTS "${CMAKE_SOURCE_DIR}/.git" OR
+   EXISTS "${CMAKE_SOURCE_DIR}/.svn" OR
+   EXISTS "${CMAKE_SOURCE_DIR}/.hg" OR
+   EXISTS "${CMAKE_SOURCE_DIR}/.bzr")
+    set(ECM_SOURCE_UNDER_VERSION_CONTROL TRUE)
+else()
+    set(ECM_SOURCE_UNDER_VERSION_CONTROL FALSE)
+endif()