Dear all,
i've now quite often encountered the need to access basic git
information about the source tree from within cmake.
i've attached the current FindGit.cmake module shipped with CMake
enhanced by two functions: getGitRevision and getGitBranch.
if you fancy the idea of having this included, feel free to include any
part of it in future releases.
if this is not the "right way" of proposing such things, where to go to?
cheers
Daniel
--
Dr. Daniel Wirtz
Dipl. Math. Dipl. Inf.
SRC SimTech
Pfaffenwaldring 5a
+49 711 685 60044
#.rst:
# FindGit
# -------
#
#
#
# The module defines the following variables:
#
# ::
#
# GIT_EXECUTABLE - path to git command line client
# GIT_FOUND - true if the command line client was found
# GIT_VERSION_STRING - the version of git found (since CMake 2.8.8)
#
# Example usage:
#
# ::
#
# find_package(Git)
# if(GIT_FOUND)
# message("git found: ${GIT_EXECUTABLE}")
# endif()
# In addition, the following functions will be provided for your convenience:
# getGitRevision(VARNAME [SOURCE_FOLDER])
# getGitBranch(VARNAME [SOURCE_FOLDER])
#
# Both functions return the current revision/branch checked out.
# If SOURCE_FOLDER is not specified, CMAKE_CURRENT_SOURCE_DIR is assumed.
#=============================================================================
# Copyright 2010 Kitware, Inc.
# Copyright 2012 Rolf Eike Beer <e...@sf-mail.de>
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
function(getGitRevision VARNAME)
if (NOT GIT_FOUND)
message(FATAL_ERROR "Cannot use getGitRevision: Git was not found.")
endif()
set(SOURCE_DIR ${ARGV1})
if(NOT SOURCE_DIR)
set(SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
endif()
execute_process(COMMAND ${GIT_EXECUTABLE} rev-list --max-count=1 HEAD
OUTPUT_VARIABLE RES
ERROR_VARIABLE ERR
OUTPUT_STRIP_TRAILING_WHITESPACE
WORKING_DIRECTORY ${SOURCE_DIR})
set(${VARNAME} ${RES} PARENT_SCOPE)
if (ERR)
message(WARNING "Issuing git command '${GIT_EXECUTABLE} rev-list --max-count=1 HEAD' failed: ${ERR}")
endif()
endfunction()
function(getGitBranch VARNAME)
if (NOT GIT_FOUND)
message(FATAL_ERROR "Cannot use getGitBranch: Git was not found.")
endif()
set(SOURCE_DIR ${ARGV1})
if(NOT SOURCE_DIR)
set(SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
endif()
execute_process(COMMAND ${GIT_EXECUTABLE} describe --all
OUTPUT_VARIABLE RES
ERROR_VARIABLE ERR
OUTPUT_STRIP_TRAILING_WHITESPACE
WORKING_DIRECTORY ${SOURCE_DIR})
if (ERR)
message(WARNING "Issuing git command '${GIT_EXECUTABLE} describe --all' failed: ${ERR}")
endif()
set(${VARNAME} ${RES} PARENT_SCOPE)
endfunction()
# Look for 'git' or 'eg' (easy git)
#
set(git_names git eg)
# Prefer .cmd variants on Windows unless running in a Makefile
# in the MSYS shell.
#
if(WIN32)
if(NOT CMAKE_GENERATOR MATCHES "MSYS")
set(git_names git.cmd git eg.cmd eg)
# GitHub search path for Windows
set(github_path "$ENV{LOCALAPPDATA}/Github/PortableGit*/bin")
file(GLOB github_path "${github_path}")
endif()
endif()
find_program(GIT_EXECUTABLE
NAMES ${git_names}
PATHS ${github_path}
PATH_SUFFIXES Git/cmd Git/bin
DOC "git command line client"
)
mark_as_advanced(GIT_EXECUTABLE)
if(GIT_EXECUTABLE)
execute_process(COMMAND ${GIT_EXECUTABLE} --version
OUTPUT_VARIABLE git_version
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE)
if (git_version MATCHES "^git version [0-9]")
string(REPLACE "git version " "" GIT_VERSION_STRING "${git_version}")
endif()
unset(git_version)
endif()
# Handle the QUIETLY and REQUIRED arguments and set GIT_FOUND to TRUE if
# all listed variables are TRUE
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Git
REQUIRED_VARS GIT_EXECUTABLE
VERSION_VAR GIT_VERSION_STRING)
--
Powered by www.kitware.com
Please keep messages on-topic and check the CMake FAQ at:
http://www.cmake.org/Wiki/CMake_FAQ
Kitware offers various services to support the CMake community. For more
information on each offering, please visit:
CMake Support: http://cmake.org/cmake/help/support.html
CMake Consulting: http://cmake.org/cmake/help/consulting.html
CMake Training Courses: http://cmake.org/cmake/help/training.html
Visit other Kitware open-source projects at
http://www.kitware.com/opensource/opensource.html
Follow this link to subscribe/unsubscribe:
http://public.kitware.com/mailman/listinfo/cmake
