Merge topic 'FindGit-updates'

fa78ee97 FindGit: Improve documentation formatting
facfb52c FindGit: Document Git_FOUND, unset internal var
This commit is contained in:
Brad King 2016-02-01 10:43:54 -05:00 committed by CMake Topic Stage
commit 5ee96fc272

View File

@ -2,27 +2,26 @@
# FindGit # FindGit
# ------- # -------
# #
#
#
# The module defines the following variables: # The module defines the following variables:
# #
# :: # ``GIT_EXECUTABLE``
# # Path to Git command-line client.
# GIT_EXECUTABLE - path to git command line client # ``Git_FOUND``, ``GIT_FOUND``
# GIT_FOUND - true if the command line client was found # True if the Git command-line client was found.
# GIT_VERSION_STRING - the version of git found (since CMake 2.8.8) # ``GIT_VERSION_STRING``
# The version of Git found.
# #
# Example usage: # Example usage:
# #
# :: # .. code-block:: cmake
# #
# find_package(Git) # find_package(Git)
# if(GIT_FOUND) # if(Git_FOUND)
# message("git found: ${GIT_EXECUTABLE}") # message("Git found: ${GIT_EXECUTABLE}")
# endif() # endif()
#============================================================================= #=============================================================================
# Copyright 2010 Kitware, Inc. # Copyright 2010-2016 Kitware, Inc.
# Copyright 2012 Rolf Eike Beer <eike@sf-mail.de> # Copyright 2012 Rolf Eike Beer <eike@sf-mail.de>
# #
# Distributed under the OSI-approved BSD License (the "License"); # Distributed under the OSI-approved BSD License (the "License");
@ -57,10 +56,11 @@ find_program(GIT_EXECUTABLE
NAMES ${git_names} NAMES ${git_names}
PATHS ${github_path} ${_git_sourcetree_path} PATHS ${github_path} ${_git_sourcetree_path}
PATH_SUFFIXES Git/cmd Git/bin PATH_SUFFIXES Git/cmd Git/bin
DOC "git command line client" DOC "Git command line client"
) )
mark_as_advanced(GIT_EXECUTABLE) mark_as_advanced(GIT_EXECUTABLE)
unset(git_names)
unset(_git_sourcetree_path) unset(_git_sourcetree_path)
if(GIT_EXECUTABLE) if(GIT_EXECUTABLE)
@ -74,7 +74,7 @@ if(GIT_EXECUTABLE)
unset(git_version) unset(git_version)
endif() endif()
# Handle the QUIETLY and REQUIRED arguments and set GIT_FOUND to TRUE if # Handle the QUIETLY and REQUIRED arguments and set Git_FOUND to TRUE if
# all listed variables are TRUE # all listed variables are TRUE
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)