cmake: Fix and simplify git version info. (#2516)
authorAina Niemetz <aina.niemetz@gmail.com>
Mon, 24 Sep 2018 19:21:14 +0000 (12:21 -0700)
committerGitHub <noreply@github.com>
Mon, 24 Sep 2018 19:21:14 +0000 (12:21 -0700)
cmake/GetGitRevisionDescription.cmake [deleted file]
cmake/GetGitRevisionDescription.cmake.in [deleted file]
src/base/CMakeLists.txt

diff --git a/cmake/GetGitRevisionDescription.cmake b/cmake/GetGitRevisionDescription.cmake
deleted file mode 100644 (file)
index 8ab03bc..0000000
+++ /dev/null
@@ -1,168 +0,0 @@
-# - Returns a version string from Git
-#
-# These functions force a re-configure on each git commit so that you can
-# trust the values of the variables in your build system.
-#
-#  get_git_head_revision(<refspecvar> <hashvar> [<additional arguments to git describe> ...])
-#
-# Returns the refspec and sha hash of the current head revision
-#
-#  git_describe(<var> [<additional arguments to git describe> ...])
-#
-# Returns the results of git describe on the source tree, and adjusting
-# the output so that it tests false if an error occurs.
-#
-#  git_get_exact_tag(<var> [<additional arguments to git describe> ...])
-#
-# Returns the results of git describe --exact-match on the source tree,
-# and adjusting the output so that it tests false if there was no exact
-# matching tag.
-#
-#  git_local_changes(<var>)
-#
-# Returns either "CLEAN" or "DIRTY" with respect to uncommitted changes.
-# Uses the return code of "git diff-index --quiet HEAD --".
-# Does not regard untracked files.
-#
-# Requires CMake 2.6 or newer (uses the 'function' command)
-#
-# Original Author:
-# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
-# http://academic.cleardefinition.com
-# Iowa State University HCI Graduate Program/VRAC
-#
-# Copyright Iowa State University 2009-2010.
-# Distributed under the Boost Software License, Version 1.0.
-# (See accompanying file LICENSE_1_0.txt or copy at
-# http://www.boost.org/LICENSE_1_0.txt)
-
-if(__get_git_revision_description)
-       return()
-endif()
-set(__get_git_revision_description YES)
-
-# We must run the following at "include" time, not at function call time,
-# to find the path to this module rather than the path to a calling list file
-get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
-
-function(get_git_head_revision _refspecvar _hashvar)
-       set(GIT_PARENT_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
-       set(GIT_DIR "${GIT_PARENT_DIR}/.git")
-       while(NOT EXISTS "${GIT_DIR}")  # .git dir not found, search parent directories
-               set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}")
-               get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH)
-               if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT)
-                       # We have reached the root directory, we are not in git
-                       set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
-                       set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
-                       return()
-               endif()
-               set(GIT_DIR "${GIT_PARENT_DIR}/.git")
-       endwhile()
-       # check if this is a submodule
-       if(NOT IS_DIRECTORY ${GIT_DIR})
-               file(READ ${GIT_DIR} submodule)
-               string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule})
-               get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH)
-               get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE)
-       endif()
-       set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data")
-       if(NOT EXISTS "${GIT_DATA}")
-               file(MAKE_DIRECTORY "${GIT_DATA}")
-       endif()
-
-       if(NOT EXISTS "${GIT_DIR}/HEAD")
-               return()
-       endif()
-       set(HEAD_FILE "${GIT_DATA}/HEAD")
-       configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY)
-
-       configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in"
-               "${GIT_DATA}/grabRef.cmake"
-               @ONLY)
-       include("${GIT_DATA}/grabRef.cmake")
-
-       set(${_refspecvar} "${HEAD_REF}" PARENT_SCOPE)
-       set(${_hashvar} "${HEAD_HASH}" PARENT_SCOPE)
-endfunction()
-
-function(git_describe _var)
-       if(NOT GIT_FOUND)
-               find_package(Git QUIET)
-       endif()
-       get_git_head_revision(refspec hash)
-       if(NOT GIT_FOUND)
-               set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
-               return()
-       endif()
-       if(NOT hash)
-               set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
-               return()
-       endif()
-
-       # TODO sanitize
-       #if((${ARGN}" MATCHES "&&") OR
-       #       (ARGN MATCHES "||") OR
-       #       (ARGN MATCHES "\\;"))
-       #       message("Please report the following error to the project!")
-       #       message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
-       #endif()
-
-       #message(STATUS "Arguments to execute_process: ${ARGN}")
-
-       execute_process(COMMAND
-               "${GIT_EXECUTABLE}"
-               describe
-               ${hash}
-               ${ARGN}
-               WORKING_DIRECTORY
-               "${CMAKE_CURRENT_SOURCE_DIR}"
-               RESULT_VARIABLE
-               res
-               OUTPUT_VARIABLE
-               out
-               ERROR_QUIET
-               OUTPUT_STRIP_TRAILING_WHITESPACE)
-       if(NOT res EQUAL 0)
-               set(out "${out}-${res}-NOTFOUND")
-       endif()
-
-       set(${_var} "${out}" PARENT_SCOPE)
-endfunction()
-
-function(git_get_exact_tag _var)
-       git_describe(out --exact-match ${ARGN})
-       set(${_var} "${out}" PARENT_SCOPE)
-endfunction()
-
-function(git_local_changes _var)
-       if(NOT GIT_FOUND)
-               find_package(Git QUIET)
-       endif()
-       get_git_head_revision(refspec hash)
-       if(NOT GIT_FOUND)
-               set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
-               return()
-       endif()
-       if(NOT hash)
-               set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
-               return()
-       endif()
-
-       execute_process(COMMAND
-               "${GIT_EXECUTABLE}"
-               diff-index --quiet HEAD --
-               WORKING_DIRECTORY
-               "${CMAKE_CURRENT_SOURCE_DIR}"
-               RESULT_VARIABLE
-               res
-               OUTPUT_VARIABLE
-               out
-               ERROR_QUIET
-               OUTPUT_STRIP_TRAILING_WHITESPACE)
-       if(res EQUAL 0)
-               set(${_var} "CLEAN" PARENT_SCOPE)
-       else()
-               set(${_var} "DIRTY" PARENT_SCOPE)
-       endif()
-endfunction()
diff --git a/cmake/GetGitRevisionDescription.cmake.in b/cmake/GetGitRevisionDescription.cmake.in
deleted file mode 100644 (file)
index 6d8b708..0000000
+++ /dev/null
@@ -1,41 +0,0 @@
-#
-# Internal file for GetGitRevisionDescription.cmake
-#
-# Requires CMake 2.6 or newer (uses the 'function' command)
-#
-# Original Author:
-# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
-# http://academic.cleardefinition.com
-# Iowa State University HCI Graduate Program/VRAC
-#
-# Copyright Iowa State University 2009-2010.
-# Distributed under the Boost Software License, Version 1.0.
-# (See accompanying file LICENSE_1_0.txt or copy at
-# http://www.boost.org/LICENSE_1_0.txt)
-
-set(HEAD_HASH)
-
-file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024)
-
-string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS)
-if(HEAD_CONTENTS MATCHES "ref")
-       # named branch
-       string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}")
-       if(EXISTS "@GIT_DIR@/${HEAD_REF}")
-               configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
-       else()
-               configure_file("@GIT_DIR@/packed-refs" "@GIT_DATA@/packed-refs" COPYONLY)
-               file(READ "@GIT_DATA@/packed-refs" PACKED_REFS)
-               if(${PACKED_REFS} MATCHES "([0-9a-z]*) ${HEAD_REF}")
-                       set(HEAD_HASH "${CMAKE_MATCH_1}")
-               endif()
-       endif()
-else()
-       # detached HEAD
-       configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY)
-endif()
-
-if(NOT HEAD_HASH)
-       file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024)
-       string(STRIP "${HEAD_HASH}" HEAD_HASH)
-endif()
index d190ec1994290067ebbddf935dcd9a718ba3e26a..c29eaa39392c7bd3ebf1aeeda19a7b234f08b351 100644 (file)
@@ -1,26 +1,38 @@
 #-----------------------------------------------------------------------------#
 # Extract info from Git for git_versioninfo.cpp
 
-include(GetGitRevisionDescription)
-get_git_head_revision(GIT_REFSPEC GIT_SHA1)
-
-if(GIT_SHA1)
-  git_local_changes(GIT_IS_DIRTY)
-  set(GIT_BUILD "true")
-  if(${GIT_IS_DIRTY} STREQUAL "DIRTY")
-    set(GIT_IS_DIRTY "true")
-  else()
-    set(GIT_IS_DIRTY "false")
-  endif()
+find_package(Git)
+
+set(GIT_BUILD "false")
+set(GIT_IS_DIRTY "false")
+set(GIT_SHA1 "")
+set(GIT_BRANCH "")
+
+if(GIT_FOUND)
+  # Get current git branch, result is != 0 if this is not a git repository
   execute_process(
     COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
+    RESULT_VARIABLE GIT_RESULT
     OUTPUT_VARIABLE GIT_BRANCH
     OUTPUT_STRIP_TRAILING_WHITESPACE
   )
-else()
-  set(GIT_BUILD "false")
-  set(GIT_IS_DIRTY "false")
-  set(GIT_SHA1 "")
+  if("${GIT_RESULT}" STREQUAL "0")
+    set(GIT_BUILD "true")
+    # Extract sha1 of HEAD
+    execute_process(
+      COMMAND ${GIT_EXECUTABLE} rev-parse HEAD
+      OUTPUT_VARIABLE GIT_SHA1
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+    # Result is != 0 if worktree is dirty
+    execute_process(
+      COMMAND git diff --quiet
+      RESULT_VARIABLE GIT_RESULT
+    )
+    if(NOT "${GIT_RESULT}" STREQUAL "0")
+      set(GIT_IS_DIRTY "true")
+    endif()
+  endif()
 endif()
 
 #-----------------------------------------------------------------------------#